Test API to control the storage FTP client

Overview

Test API to FTP client routines. More…

// typedefs

typedef struct tapi_storage_client_ftp_context tapi_storage_client_ftp_context;

// global variables

tapi_storage_client_methods tapi_storage_client_ftp_methods;

// global functions

te_errno tapi_storage_client_ftp_context_init(tapi_storage_client_ftp_context** context);
void tapi_storage_client_ftp_context_fini(tapi_storage_client_ftp_context* context);
te_errno tapi_storage_client_ftp_init(rcf_rpc_server* rpcs, const tapi_storage_client_methods* methods, tapi_storage_auth_params* auth, tapi_storage_client_ftp_context* context, tapi_storage_client* client);
void tapi_storage_client_ftp_fini(tapi_storage_client* client);

Detailed Documentation

Test API to FTP client routines.

Global Variables

tapi_storage_client_methods tapi_storage_client_ftp_methods

Pre initialized methods to operate the FTP client. It should be passed to tapi_storage_client_init to initialize the service.

See also:

tapi_storage_client_init

Global Functions

te_errno tapi_storage_client_ftp_context_init(tapi_storage_client_ftp_context** context)

Initialize FTP client context. Context should be released with tapi_storage_client_ftp_context_fini when it is no longer needed.

Parameters:

context

FTP client context handle.

Returns:

Status code.

See also:

tapi_storage_client_ftp_context_fini

void tapi_storage_client_ftp_context_fini(tapi_storage_client_ftp_context* context)

Release FTP client context that was initialized with tapi_storage_client_ftp_context_init.

Parameters:

context

FTP client context handle.

See also:

tapi_storage_client_ftp_context_init

te_errno tapi_storage_client_ftp_init(rcf_rpc_server* rpcs, const tapi_storage_client_methods* methods, tapi_storage_auth_params* auth, tapi_storage_client_ftp_context* context, tapi_storage_client* client)

Initialize FTP client handle. Client should be released with tapi_storage_client_ftp_fini when it is no longer needed.

Parameters:

rpcs	RPC server handle.
methods	Back-end client scpecific methods. If `NULL` then default methods will be used. Default methods is defined in tapi_storage_client_ftp.c.
auth	Back-end client specific authorization parameters. May be `NULL`.
context	Back-end client scpecific context. Don’t free the `context` before finishing work with `client`.
client	FTP client handle.

Returns:

Status code.

See also:

tapi_storage_client_ftp_fini

void tapi_storage_client_ftp_fini(tapi_storage_client* client)

Release FTP client that was initialized with tapi_storage_client_ftp_init.

Parameters:

client

FTP client handle.

See also:

tapi_storage_client_ftp_init