:orphan:

.. index:: pair: group; Test API to control the storage FTP client
.. _doxid-group__tapi__storage__client__ftp:

Test API to control the storage FTP client
==========================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Test API to FTP client routines. :ref:`More...<details-group__tapi__storage__client__ftp>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	
	// typedefs

	typedef struct tapi_storage_client_ftp_context :target:`tapi_storage_client_ftp_context<doxid-group__tapi__storage__client__ftp_1ga0755c5b3acd2c57a621a60ae6be27304>`;

	// global variables

	:ref:`tapi_storage_client_methods<doxid-structtapi__storage__client__methods>` :ref:`tapi_storage_client_ftp_methods<doxid-group__tapi__storage__client__ftp_1ga977102af4b7e793b91bf9ce4418fcc74>`;

	// global functions

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_storage_client_ftp_context_init<doxid-group__tapi__storage__client__ftp_1ga36805d29f82a66784ca737b2c831a8d8>`(tapi_storage_client_ftp_context** context);
	void :ref:`tapi_storage_client_ftp_context_fini<doxid-group__tapi__storage__client__ftp_1gab1394318b0532a80a33be627b8a00b9a>`(tapi_storage_client_ftp_context* context);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_storage_client_ftp_init<doxid-group__tapi__storage__client__ftp_1gabf623735f4dc8d01b8fd222c647a77b0>`(:ref:`rcf_rpc_server<doxid-structrcf__rpc__server>`* rpcs, const :ref:`tapi_storage_client_methods<doxid-structtapi__storage__client__methods>`* methods, :ref:`tapi_storage_auth_params<doxid-structtapi__storage__auth__params>`* auth, tapi_storage_client_ftp_context* context, :ref:`tapi_storage_client<doxid-structtapi__storage__client>`* client);
	void :ref:`tapi_storage_client_ftp_fini<doxid-group__tapi__storage__client__ftp_1ga1e1f0d650559b0452add6c097a92344e>`(:ref:`tapi_storage_client<doxid-structtapi__storage__client>`* client);

.. _details-group__tapi__storage__client__ftp:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

Test API to FTP client routines.

Copyright (C) 2004-2022 OKTET Labs Ltd. All rights reserved.

Global Variables
----------------

.. index:: pair: variable; tapi_storage_client_ftp_methods
.. _doxid-group__tapi__storage__client__ftp_1ga977102af4b7e793b91bf9ce4418fcc74:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`tapi_storage_client_methods<doxid-structtapi__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.



.. rubric:: See also:

:ref:`tapi_storage_client_init <doxid-group__tapi__storage__client_1gaa783b4f5ef241aeab1de5bd7c149c0f6>`

Global Functions
----------------

.. index:: pair: function; tapi_storage_client_ftp_context_init
.. _doxid-group__tapi__storage__client__ftp_1ga36805d29f82a66784ca737b2c831a8d8:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` 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.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- context

		- FTP client context handle.



.. rubric:: Returns:

Status code.



.. rubric:: See also:

:ref:`tapi_storage_client_ftp_context_fini <doxid-group__tapi__storage__client__ftp_1gab1394318b0532a80a33be627b8a00b9a>`

.. index:: pair: function; tapi_storage_client_ftp_context_fini
.. _doxid-group__tapi__storage__client__ftp_1gab1394318b0532a80a33be627b8a00b9a:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	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``.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- context

		- FTP client context handle.



.. rubric:: See also:

:ref:`tapi_storage_client_ftp_context_init <doxid-group__tapi__storage__client__ftp_1ga36805d29f82a66784ca737b2c831a8d8>`

.. index:: pair: function; tapi_storage_client_ftp_init
.. _doxid-group__tapi__storage__client__ftp_1gabf623735f4dc8d01b8fd222c647a77b0:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_storage_client_ftp_init(:ref:`rcf_rpc_server<doxid-structrcf__rpc__server>`* rpcs, const :ref:`tapi_storage_client_methods<doxid-structtapi__storage__client__methods>`* methods, :ref:`tapi_storage_auth_params<doxid-structtapi__storage__auth__params>`* auth, tapi_storage_client_ftp_context* context, :ref:`tapi_storage_client<doxid-structtapi__storage__client>`* client)

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



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- 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.



.. rubric:: Returns:

Status code.



.. rubric:: See also:

:ref:`tapi_storage_client_ftp_fini <doxid-group__tapi__storage__client__ftp_1ga1e1f0d650559b0452add6c097a92344e>`

.. index:: pair: function; tapi_storage_client_ftp_fini
.. _doxid-group__tapi__storage__client__ftp_1ga1e1f0d650559b0452add6c097a92344e:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void tapi_storage_client_ftp_fini(:ref:`tapi_storage_client<doxid-structtapi__storage__client>`* client)

Release FTP client that was initialized with ``tapi_storage_client_ftp_init``.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- client

		- FTP client handle.



.. rubric:: See also:

:ref:`tapi_storage_client_ftp_init <doxid-group__tapi__storage__client__ftp_1gabf623735f4dc8d01b8fd222c647a77b0>`