Asynchronous management

Asynchronous REST operations. More...

Functions
dpl_task_t *	dpl_list_all_my_buckets_async_prepare (dpl_ctx_t *ctx)
	list all buckets More...
dpl_task_t *	dpl_list_bucket_async_prepare (dpl_ctx_t *ctx, const char *bucket, const char *prefix, const char *delimiter)
	list bucket or directory More...
dpl_task_t *	dpl_make_bucket_async_prepare (dpl_ctx_t *ctx, const char *bucket, dpl_location_constraint_t location_constraint, dpl_canned_acl_t canned_acl)
	make a bucket More...
dpl_task_t *	dpl_delete_bucket_prepare (dpl_ctx_t *ctx, const char *bucket)
	delete a resource More...
dpl_task_t *	dpl_post_async_prepare (dpl_ctx_t *ctx, const char *bucket, const char *resource, const dpl_option_t *option, dpl_ftype_t object_type, const dpl_condition_t *condition, const dpl_range_t *range, const dpl_dict_t *metadata, const dpl_sysmd_t *sysmd, dpl_buf_t *buf, const dpl_dict_t *query_params)
	create or post data into a resource More...
dpl_task_t *	dpl_put_async_prepare (dpl_ctx_t *ctx, const char *bucket, const char *resource, const dpl_option_t *option, dpl_ftype_t object_type, const dpl_condition_t *condition, const dpl_range_t *range, const dpl_dict_t *metadata, const dpl_sysmd_t *sysmd, dpl_buf_t *buf)
	put a resource More...
dpl_task_t *	dpl_get_async_prepare (dpl_ctx_t *ctx, const char *bucket, const char *resource, const dpl_option_t *option, dpl_ftype_t object_type, const dpl_condition_t *condition, const dpl_range_t *range)
	get a resource with range More...
dpl_task_t *	dpl_head_async_prepare (dpl_ctx_t *ctx, const char *bucket, const char *resource, const dpl_option_t *option, dpl_ftype_t object_type, const dpl_condition_t *condition)
	get user and system metadata More...
dpl_task_t *	dpl_delete_async_prepare (dpl_ctx_t *ctx, const char *bucket, const char *resource, const dpl_option_t *option, dpl_ftype_t object_type, const dpl_condition_t *condition)
	delete a resource More...
dpl_task_t *	dpl_copy_async_prepare (dpl_ctx_t *ctx, const char *src_bucket, const char *src_resource, const char *dst_bucket, const char *dst_resource, const dpl_option_t *option, dpl_ftype_t object_type, dpl_copy_directive_t copy_directive, const dpl_dict_t *metadata, const dpl_sysmd_t *sysmd, const dpl_condition_t *condition)
	perform various flavors of server side copies More...
dpl_task_t *	dpl_post_id_async_prepare (dpl_ctx_t *ctx, const char *bucket, const char *id, const dpl_option_t *option, dpl_ftype_t object_type, const dpl_condition_t *condition, const dpl_range_t *range, const dpl_dict_t *metadata, const dpl_sysmd_t *sysmd, dpl_buf_t *buf, const dpl_dict_t *query_params)
	create or post data into a resource More...
dpl_task_t *	dpl_put_id_async_prepare (dpl_ctx_t *ctx, const char *bucket, const char *resource, const dpl_option_t *option, dpl_ftype_t object_type, const dpl_condition_t *condition, const dpl_range_t *range, const dpl_dict_t *metadata, const dpl_sysmd_t *sysmd, dpl_buf_t *buf)
	put a resource More...
dpl_task_t *	dpl_get_id_async_prepare (dpl_ctx_t *ctx, const char *bucket, const char *resource, const dpl_option_t *option, dpl_ftype_t object_type, const dpl_condition_t *condition, const dpl_range_t *range)
	get a resource with range More...
dpl_task_t *	dpl_head_id_async_prepare (dpl_ctx_t *ctx, const char *bucket, const char *resource, const dpl_option_t *option, dpl_ftype_t object_type, const dpl_condition_t *condition)
	get user and system metadata More...
dpl_task_t *	dpl_delete_id_async_prepare (dpl_ctx_t *ctx, const char *bucket, const char *resource, const dpl_option_t *option, dpl_ftype_t object_type, const dpl_condition_t *condition)
	delete a resource More...
dpl_task_t *	dpl_copy_id_async_prepare (dpl_ctx_t *ctx, const char *src_bucket, const char *src_resource, const char *dst_bucket, const char *dst_resource, const dpl_option_t *option, dpl_ftype_t object_type, dpl_copy_directive_t copy_directive, const dpl_dict_t *metadata, const dpl_sysmd_t *sysmd, const dpl_condition_t *condition)
	perform various flavors of server side copies More...

Detailed Description

Function Documentation

dpl_task_t* dpl_copy_async_prepare	(	dpl_ctx_t *	ctx,
		const char *	src_bucket,
		const char *	src_resource,
		const char *	dst_bucket,
		const char *	dst_resource,
		const dpl_option_t *	option,
		dpl_ftype_t	object_type,
		dpl_copy_directive_t	copy_directive,
		const dpl_dict_t *	metadata,
		const dpl_sysmd_t *	sysmd,
		const dpl_condition_t *	condition
	)

Parameters

ctx	the droplet context
src_bucket	the optional source bucket
src_resource	the mandat source resource
dst_bucket	the optional destination bucket
dst_resource	the optional destination resource (if dst equals src)
option	unused
object_type	unused
copy_directive	DPL_COPY_DIRECTIVE_COPY server side copy
copy_directive	DPL_COPY_DIRECTIVE_METADATA_REPLACE setattr
copy_directive	DPL_COPY_DIRECTIVE_LINK hard link
copy_directive	DPL_COPY_DIRECTIVE_SYMLINK reference
copy_directive	DPL_COPY_DIRECTIVE_MOVE rename
copy_directive	DPL_COPY_DIRECTIVE_MKDENT create a directory entry
metadata	the optional user metadata
sysmd	the optional system metadata
condition	the optional condition

Returns

DPL_SUCCESS

DPL_FAILURE

dpl_task_t* dpl_copy_id_async_prepare	(	dpl_ctx_t *	ctx,
		const char *	src_bucket,
		const char *	src_resource,
		const char *	dst_bucket,
		const char *	dst_resource,
		const dpl_option_t *	option,
		dpl_ftype_t	object_type,
		dpl_copy_directive_t	copy_directive,
		const dpl_dict_t *	metadata,
		const dpl_sysmd_t *	sysmd,
		const dpl_condition_t *	condition
	)

Parameters

ctx	the droplet context
src_bucket	the optional source bucket
src_resource	the mandat source resource
dst_bucket	the optional destination bucket
dst_resource	the optional destination resource (if dst equals src)
option	unused
object_type	unused
copy_directive	DPL_COPY_DIRECTIVE_COPY server side copy
copy_directive	DPL_COPY_DIRECTIVE_METADATA_REPLACE setattr
copy_directive	DPL_COPY_DIRECTIVE_LINK hard link
copy_directive	DPL_COPY_DIRECTIVE_SYMLINK reference
copy_directive	DPL_COPY_DIRECTIVE_MOVE rename
copy_directive	DPL_COPY_DIRECTIVE_MKDENT create a directory entry
metadata	the optional user metadata
sysmd	the optional system metadata
condition	the optional condition

Returns

DPL_SUCCESS

DPL_FAILURE

dpl_task_t* dpl_delete_async_prepare	(	dpl_ctx_t *	ctx,
		const char *	bucket,
		const char *	resource,
		const dpl_option_t *	option,
		dpl_ftype_t	object_type,
		const dpl_condition_t *	condition
	)

Parameters

ctx	the droplet context
bucket	the optional bucket
resource	the mandat resource
option	DPL_OPTION_HTTP_COMPAT use if possible the HTTP compat mode
condition	the optional condition

Returns

DPL_SUCCESS

DPL_FAILURE

DPL_ENOENT resource does not exist

dpl_task_t* dpl_delete_bucket_prepare	(	dpl_ctx_t *	ctx,
		const char *	bucket
	)

Parameters

ctx	the droplet context
bucket	can be NULL

Returns

task

dpl_task_t* dpl_delete_id_async_prepare	(	dpl_ctx_t *	ctx,
		const char *	bucket,
		const char *	resource,
		const dpl_option_t *	option,
		dpl_ftype_t	object_type,
		const dpl_condition_t *	condition
	)

Parameters

ctx	the droplet context
bucket	the optional bucket
resource	the mandat resource
option	DPL_OPTION_HTTP_COMPAT use if possible the HTTP compat mode
condition	the optional condition

Returns

DPL_SUCCESS

DPL_FAILURE

DPL_ENOENT resource does not exist

dpl_task_t* dpl_get_async_prepare	(	dpl_ctx_t *	ctx,
		const char *	bucket,
		const char *	resource,
		const dpl_option_t *	option,
		dpl_ftype_t	object_type,
		const dpl_condition_t *	condition,
		const dpl_range_t *	range
	)

Parameters

ctx	the droplet context
bucket	the optional bucket
resource	the mandat resource
option	DPL_OPTION_HTTP_COMPAT use if possible the HTTP compat mode
object_type	DPL_FTYPE_ANY get any type of resource
condition	the optional condition
range	the optional range

Returns

DPL_SUCCESS

DPL_FAILURE

DPL_ENOENT resource does not exist

dpl_task_t* dpl_get_id_async_prepare	(	dpl_ctx_t *	ctx,
		const char *	bucket,
		const char *	resource,
		const dpl_option_t *	option,
		dpl_ftype_t	object_type,
		const dpl_condition_t *	condition,
		const dpl_range_t *	range
	)

Parameters

ctx	the droplet context
bucket	the optional bucket
resource	the mandat resource
option	DPL_OPTION_HTTP_COMPAT use if possible the HTTP compat mode
object_type	DPL_FTYPE_ANY get any type of resource
condition	the optional condition
range	the optional range

Returns

DPL_SUCCESS

DPL_FAILURE

DPL_ENOENT resource does not exist

dpl_task_t* dpl_head_async_prepare	(	dpl_ctx_t *	ctx,
		const char *	bucket,
		const char *	resource,
		const dpl_option_t *	option,
		dpl_ftype_t	object_type,
		const dpl_condition_t *	condition
	)

Parameters

ctx	the droplet context
bucket	the optional bucket
resource	the mandat resource
option	DPL_OPTION_HTTP_COMPAT use if possible the HTTP compat mode
object_type	DPL_FTYPE_ANY get any type of resource
condition	the optional condition
metadatap	the returned user metadata client shall free
sysmdp	the returned system metadata passed through stack

Returns

DPL_SUCCESS

DPL_FAILURE

DPL_ENOENT resource does not exist

dpl_task_t* dpl_head_id_async_prepare	(	dpl_ctx_t *	ctx,
		const char *	bucket,
		const char *	resource,
		const dpl_option_t *	option,
		dpl_ftype_t	object_type,
		const dpl_condition_t *	condition
	)

Parameters

ctx	the droplet context
bucket	the optional bucket
resource	the mandat resource
option	DPL_OPTION_HTTP_COMPAT use if possible the HTTP compat mode
object_type	DPL_FTYPE_ANY get any type of resource
condition	the optional condition
metadatap	the returned user metadata client shall free
sysmdp	the returned system metadata passed through stack

Returns

DPL_SUCCESS

DPL_FAILURE

DPL_ENOENT resource does not exist

dpl_task_t* dpl_list_all_my_buckets_async_prepare

(

dpl_ctx_t *

ctx

)

Parameters

ctx	the droplect context
cb_func	all callback returning a vector of dpl_bucket_t *
cb_arg	closure

Returns

task

dpl_task_t* dpl_list_bucket_async_prepare	(	dpl_ctx_t *	ctx,
		const char *	bucket,
		const char *	prefix,
		const char *	delimiter
	)

Parameters

ctx	the droplet context
bucket	can be NULL
prefix	directory can be NULL
delimiter	e.g. "/" can be NULL
cb_func
cb_arg

Returns

task

dpl_task_t* dpl_make_bucket_async_prepare	(	dpl_ctx_t *	ctx,
		const char *	bucket,
		dpl_location_constraint_t	location_constraint,
		dpl_canned_acl_t	canned_acl
	)

Parameters

ctx	the droplet context
bucket	can be NULL
location_constraint	geographic location
canned_acl	simplified ACL

Returns

task

dpl_task_t* dpl_post_async_prepare	(	dpl_ctx_t *	ctx,
		const char *	bucket,
		const char *	resource,
		const dpl_option_t *	option,
		dpl_ftype_t	object_type,
		const dpl_condition_t *	condition,
		const dpl_range_t *	range,
		const dpl_dict_t *	metadata,
		const dpl_sysmd_t *	sysmd,
		dpl_buf_t *	buf,
		const dpl_dict_t *	query_params
	)

Note

this function is expected to return a newly created object

Parameters

ctx	the droplet context
bucket	can be NULL
resource	can be NULL
option	DPL_OPTION_HTTP_COMPAT use if possible the HTTP compat mode
object_type	DPL_FTYPE_REG create a file
metadata	the user metadata. optional
sysmd	the system metadata. optional
buf	the data buffer
query_params	can be NULL
returned_sysmdp	the returned system metadata passed through stack

Returns

DPL_SUCCESS

DPL_FAILURE

dpl_task_t* dpl_post_id_async_prepare	(	dpl_ctx_t *	ctx,
		const char *	bucket,
		const char *	id,
		const dpl_option_t *	option,
		dpl_ftype_t	object_type,
		const dpl_condition_t *	condition,
		const dpl_range_t *	range,
		const dpl_dict_t *	metadata,
		const dpl_sysmd_t *	sysmd,
		dpl_buf_t *	buf,
		const dpl_dict_t *	query_params
	)

Note

this function is expected to return a newly created object

Parameters

ctx	the droplet context
bucket	can be NULL
option	DPL_OPTION_HTTP_COMPAT use if possible the HTTP compat mode
object_type	DPL_FTYPE_REG create a file
metadata	the user metadata. optional
sysmd	the system metadata. optional
buf	the data buffer
query_params	can be NULL
returned_sysmdp	the returned system metadata passed through stack

Returns

DPL_SUCCESS

DPL_FAILURE

dpl_task_t* dpl_put_async_prepare	(	dpl_ctx_t *	ctx,
		const char *	bucket,
		const char *	resource,
		const dpl_option_t *	option,
		dpl_ftype_t	object_type,
		const dpl_condition_t *	condition,
		const dpl_range_t *	range,
		const dpl_dict_t *	metadata,
		const dpl_sysmd_t *	sysmd,
		dpl_buf_t *	buf
	)

Parameters

ctx	the droplet context
bucket	optional
resource	mandatory
option	DPL_OPTION_HTTP_COMPAT use if possible the HTTP compat mode
object_type	DPL_FTYPE_REG create a file
object_type	DPL_FTYPE_DIR create a directory
condition	the optional condition
range	optional range
metadata	the optional user metadata
sysmd	the optional system metadata
buf	the data buffer

Returns

DPL_SUCCESS

DPL_FAILURE

DPL_EEXIST

dpl_task_t* dpl_put_id_async_prepare	(	dpl_ctx_t *	ctx,
		const char *	bucket,
		const char *	resource,
		const dpl_option_t *	option,
		dpl_ftype_t	object_type,
		const dpl_condition_t *	condition,
		const dpl_range_t *	range,
		const dpl_dict_t *	metadata,
		const dpl_sysmd_t *	sysmd,
		dpl_buf_t *	buf
	)

Parameters

ctx	the droplet context
bucket	optional
resource	mandatory
option	DPL_OPTION_HTTP_COMPAT use if possible the HTTP compat mode
object_type	DPL_FTYPE_REG create a file
object_type	DPL_FTYPE_DIR create a directory
condition	the optional condition
range	optional range
metadata	the optional user metadata
sysmd	the optional system metadata
buf	the data buffer

Returns

DPL_SUCCESS

DPL_FAILURE

DPL_EEXIST