:orphan: .. index:: pair: group; Test API to control the storage client .. _doxid-group__tapi__storage__client: Test API to control the storage client ====================================== .. toctree:: :hidden: struct_tapi_storage_client.rst struct_tapi_storage_client_methods.rst Overview ~~~~~~~~ Generic client functions for storage service. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // typedefs typedef struct :ref:`tapi_storage_client` :target:`tapi_storage_client`; typedef :ref:`te_errno` (*:ref:`tapi_storage_client_method_open`)(tapi_storage_client *client); typedef :ref:`te_errno` (*:ref:`tapi_storage_client_method_close`)(tapi_storage_client *client); typedef :ref:`te_errno` (*:ref:`tapi_storage_client_method_pwd`)( tapi_storage_client *client, tapi_local_file *directory ); typedef :ref:`te_errno` (*:ref:`tapi_storage_client_method_ls`)( tapi_storage_client *client, const char *path, tapi_local_file_list *files ); typedef :ref:`te_errno` (*:ref:`tapi_storage_client_method_cd`)( tapi_storage_client *client, const char *remote_directory ); typedef :ref:`te_errno` (*:ref:`tapi_storage_client_method_put`)( tapi_storage_client *client, const char *local_file, const char *remote_file ); typedef :ref:`te_errno` (*:ref:`tapi_storage_client_method_get`)( tapi_storage_client *client, const char *remote_file, const char *local_file ); typedef :ref:`te_errno` (*:ref:`tapi_storage_client_method_rm`)( tapi_storage_client *client, const char *filename, bool recursive ); typedef :ref:`te_errno` (*:ref:`tapi_storage_client_method_mkdir`)( tapi_storage_client *client, const char *directory_name ); typedef :ref:`te_errno` (*:ref:`tapi_storage_client_method_rmdir`)( tapi_storage_client *client, const char *directory_name ); typedef struct :ref:`tapi_storage_client_methods` :ref:`tapi_storage_client_methods`; // structs struct :ref:`tapi_storage_client`; struct :ref:`tapi_storage_client_methods`; // global functions static :ref:`te_errno` :ref:`tapi_storage_client_connect`(:ref:`tapi_storage_client`* client); static :ref:`te_errno` :ref:`tapi_storage_client_disconnect`(:ref:`tapi_storage_client`* client); static :ref:`te_errno` :ref:`tapi_storage_client_pwd`(:ref:`tapi_storage_client`* client, :ref:`tapi_local_file`* directory); static :ref:`te_errno` :ref:`tapi_storage_client_ls`(:ref:`tapi_storage_client`* client, const char* path, tapi_local_file_list* files); static :ref:`te_errno` :ref:`tapi_storage_client_cd`(:ref:`tapi_storage_client`* client, const char* remote_directory); static :ref:`te_errno` :ref:`tapi_storage_client_put`(:ref:`tapi_storage_client`* client, const char* local_file, const char* remote_file); static :ref:`te_errno` :ref:`tapi_storage_client_get`(:ref:`tapi_storage_client`* client, const char* remote_file, const char* local_file); static :ref:`te_errno` :ref:`tapi_storage_client_rm`(:ref:`tapi_storage_client`* client, const char* filename, bool recursive); static :ref:`te_errno` :ref:`tapi_storage_client_mkdir`(:ref:`tapi_storage_client`* client, const char* directory_name); static :ref:`te_errno` :ref:`tapi_storage_client_rmdir`(:ref:`tapi_storage_client`* client, const char* directory_name); :ref:`te_errno` :ref:`tapi_storage_client_init`(:ref:`tapi_storage_service_type` type, :ref:`rcf_rpc_server`* rpcs, const :ref:`tapi_storage_client_methods`* methods, :ref:`tapi_storage_auth_params`* auth, void* context, :ref:`tapi_storage_client`* client); void :ref:`tapi_storage_client_fini`(:ref:`tapi_storage_client`* client); :ref:`te_errno` :ref:`tapi_storage_client_mput`(:ref:`tapi_storage_client`* client, const :ref:`tapi_local_file`* local_file, const char* remote_file, bool recursive, bool force); :ref:`te_errno` :ref:`tapi_storage_client_mget`(:ref:`tapi_storage_client`* client, const char* remote_file, const char* local_file, bool recursive); // macros #define :ref:`TAPI_STORAGE_CLIENT_INIT` .. _details-group__tapi__storage__client: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Generic client functions for storage service. Copyright (C) 2004-2022 OKTET Labs Ltd. All rights reserved. Typedefs -------- .. index:: pair: typedef; tapi_storage_client_method_open .. _doxid-group__tapi__storage__client_1gac779c45098636fb9f02cb2c62c44aecf: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef :ref:`te_errno` (*tapi_storage_client_method_open)(tapi_storage_client *client) Open a connection. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - client - Client handle. .. rubric:: Returns: Status code. .. index:: pair: typedef; tapi_storage_client_method_close .. _doxid-group__tapi__storage__client_1ga2cc76f1b73c89f2fbf4f30f8d8e50f7c: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef :ref:`te_errno` (*tapi_storage_client_method_close)(tapi_storage_client *client) Close the connection. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - client - Client handle. .. rubric:: Returns: Status code. .. index:: pair: typedef; tapi_storage_client_method_pwd .. _doxid-group__tapi__storage__client_1ga910b55cdb6c0f6856764cf701671e6ed: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef :ref:`te_errno` (*tapi_storage_client_method_pwd)( tapi_storage_client *client, tapi_local_file *directory ) Get current work directory name. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - client - Client handle. * - directory - File context where the directory name will be saved. .. rubric:: Returns: Status code. .. index:: pair: typedef; tapi_storage_client_method_ls .. _doxid-group__tapi__storage__client_1ga7b3c71ba48cc4fb509e4d48214e7784b: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef :ref:`te_errno` (*tapi_storage_client_method_ls)( tapi_storage_client *client, const char *path, tapi_local_file_list *files ) Get files list. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - service - Service handle. * - path - Path to the files. * - files - Files list. .. rubric:: Returns: Status code. .. index:: pair: typedef; tapi_storage_client_method_cd .. _doxid-group__tapi__storage__client_1ga56ae6ad9b112b18bc7a6b03ec64d9b2b: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef :ref:`te_errno` (*tapi_storage_client_method_cd)( tapi_storage_client *client, const char *remote_directory ) Change remote work directory. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - client - Client handle. * - remote_directory - Remote directory. .. rubric:: Returns: Status code. .. index:: pair: typedef; tapi_storage_client_method_put .. _doxid-group__tapi__storage__client_1ga7560965377253389d06f7af47faad584: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef :ref:`te_errno` (*tapi_storage_client_method_put)( tapi_storage_client *client, const char *local_file, const char *remote_file ) Put a local file to remote storage. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - client - Client handle. * - local_file - Local file name. * - remote_file - Remote file name or ``NULL`` to use the same. .. rubric:: Returns: Status code. .. index:: pair: typedef; tapi_storage_client_method_get .. _doxid-group__tapi__storage__client_1gabaff1f654dfd5e2fa231cb20ed38e926: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef :ref:`te_errno` (*tapi_storage_client_method_get)( tapi_storage_client *client, const char *remote_file, const char *local_file ) Get a file from remote storage. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - client - Client handle. * - remote_file - Remote file name. * - local_file - Local file name or ``NULL`` to use the same. .. rubric:: Returns: Status code. .. index:: pair: typedef; tapi_storage_client_method_rm .. _doxid-group__tapi__storage__client_1ga6bdfd390aa3c76d8a0bf335776c1318d: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef :ref:`te_errno` (*tapi_storage_client_method_rm)( tapi_storage_client *client, const char *filename, bool recursive ) Remove a file(s) from the current working directory on the remote storage. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - client - Client handle. * - filename - Remote file name to remove. * - recursive - Perform recursive removing if ``true`` and specified file is directory. .. rubric:: Returns: Status code. .. index:: pair: typedef; tapi_storage_client_method_mkdir .. _doxid-group__tapi__storage__client_1gaf76c8f5fe929091e4b99155bbf198a4e: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef :ref:`te_errno` (*tapi_storage_client_method_mkdir)( tapi_storage_client *client, const char *directory_name ) Make a new directory in the current working directory on the remote storage. It behaves like a 'mkdir -p' i.e. it creates a parent directories as needed. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - client - Client handle. * - directory_name - Directory name to create on remote storage. .. rubric:: Returns: Status code. .. index:: pair: typedef; tapi_storage_client_method_rmdir .. _doxid-group__tapi__storage__client_1ga317652875a0ddeece3a45211d029ecdc: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef :ref:`te_errno` (*tapi_storage_client_method_rmdir)( tapi_storage_client *client, const char *directory_name ) Remove the directory from the remote storage. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - client - Client handle. * - directory_name - Directory name to remove it from the remote storage. .. rubric:: Returns: Status code. .. index:: pair: typedef; tapi_storage_client_methods .. _doxid-group__tapi__storage__client_1gaf38119e742372846111388f6181c9c28: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_storage_client_methods` tapi_storage_client_methods Methods to operate the client. Global Functions ---------------- .. index:: pair: function; tapi_storage_client_connect .. _doxid-group__tapi__storage__client_1ga4c1a49f18929dd84b76d17d7feddd488: .. ref-code-block:: cpp :class: doxyrest-title-code-block static :ref:`te_errno` tapi_storage_client_connect(:ref:`tapi_storage_client`* client) Open a connection. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - client - Client handle. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_storage_client_disconnect .. _doxid-group__tapi__storage__client_1gaf70286082d40dccec965947139805f8c: .. ref-code-block:: cpp :class: doxyrest-title-code-block static :ref:`te_errno` tapi_storage_client_disconnect(:ref:`tapi_storage_client`* client) Close the connection. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - client - Client handle. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_storage_client_pwd .. _doxid-group__tapi__storage__client_1ga2f8d776c5d5ff28b8f5e89d5c9f3e4e5: .. ref-code-block:: cpp :class: doxyrest-title-code-block static :ref:`te_errno` tapi_storage_client_pwd(:ref:`tapi_storage_client`* client, :ref:`tapi_local_file`* directory) Get current work directory name. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - client - Client handle. * - directory - File context where the directory name will be saved. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_storage_client_ls .. _doxid-group__tapi__storage__client_1ga5809c08a72dd64482951225e8e22ef29: .. ref-code-block:: cpp :class: doxyrest-title-code-block static :ref:`te_errno` tapi_storage_client_ls(:ref:`tapi_storage_client`* client, const char* path, tapi_local_file_list* files) Get files list. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - service - Service handle. * - path - Path to the files. * - files - Files list. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_storage_client_cd .. _doxid-group__tapi__storage__client_1gaab7e7864cd7c80355d3383fce19844a4: .. ref-code-block:: cpp :class: doxyrest-title-code-block static :ref:`te_errno` tapi_storage_client_cd(:ref:`tapi_storage_client`* client, const char* remote_directory) Change remote work directory. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - client - Client handle. * - remote_directory - Remote directory. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_storage_client_put .. _doxid-group__tapi__storage__client_1gae670755b78a06b17512eb13f743410f0: .. ref-code-block:: cpp :class: doxyrest-title-code-block static :ref:`te_errno` tapi_storage_client_put(:ref:`tapi_storage_client`* client, const char* local_file, const char* remote_file) Put a local file to remote storage. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - client - Client handle. * - local_file - Local file name. * - remote_file - Remote file name or ``NULL`` to use the same. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_storage_client_get .. _doxid-group__tapi__storage__client_1ga46e31bc6d666fedd830652e40c7d1ca1: .. ref-code-block:: cpp :class: doxyrest-title-code-block static :ref:`te_errno` tapi_storage_client_get(:ref:`tapi_storage_client`* client, const char* remote_file, const char* local_file) Get a file from remote storage. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - client - Client handle. * - remote_file - Remote file name. * - local_file - Local file name or ``NULL`` to use the same. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_storage_client_rm .. _doxid-group__tapi__storage__client_1ga36344056b89714c891a4933963d31393: .. ref-code-block:: cpp :class: doxyrest-title-code-block static :ref:`te_errno` tapi_storage_client_rm(:ref:`tapi_storage_client`* client, const char* filename, bool recursive) Remove a file(s) from the current working directory on the remote storage. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - client - Client handle. * - filename - Remote file name to remove. * - recursive - Perform recursive removing if ``true`` and specified file is directory. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_storage_client_mkdir .. _doxid-group__tapi__storage__client_1gaeda1a75eb4cf71d237a9407963e42b79: .. ref-code-block:: cpp :class: doxyrest-title-code-block static :ref:`te_errno` tapi_storage_client_mkdir(:ref:`tapi_storage_client`* client, const char* directory_name) Make a new directory in the current working directory on the remote storage. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - client - Client handle. * - directory_name - Directory name to create on remote storage. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_storage_client_rmdir .. _doxid-group__tapi__storage__client_1ga468c5b7eeb8de045b60ddf9eaefcb763: .. ref-code-block:: cpp :class: doxyrest-title-code-block static :ref:`te_errno` tapi_storage_client_rmdir(:ref:`tapi_storage_client`* client, const char* directory_name) Remove the directory from the remote storage. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - client - Client handle. * - directory_name - Directory name to remove it from the remote storage. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_storage_client_init .. _doxid-group__tapi__storage__client_1gaa783b4f5ef241aeab1de5bd7c149c0f6: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_storage_client_init(:ref:`tapi_storage_service_type` type, :ref:`rcf_rpc_server`* rpcs, const :ref:`tapi_storage_client_methods`* methods, :ref:`tapi_storage_auth_params`* auth, void* context, :ref:`tapi_storage_client`* client) Initialize client handle. Client should be released with ``tapi_storage_client_fini`` when it is no longer needed. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - type - Back-end client type. * - rpcs - RPC server handle. * - methods - Back-end client scpecific methods. * - auth - Back-end client specific authorization parameters. May be ``NULL``. * - context - Back-end client specific context. Don't free the ``context`` before finishing work with ``client``. * - client - Client handle. .. rubric:: Returns: Status code. .. rubric:: See also: :ref:`tapi_storage_client_fini ` .. index:: pair: function; tapi_storage_client_fini .. _doxid-group__tapi__storage__client_1ga6e1d2fc254a32d8858e9e22084198cf6: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_storage_client_fini(:ref:`tapi_storage_client`* client) Release client that was initialized with ``tapi_storage_client_init``. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - client - Client handle. .. rubric:: Returns: Status code. .. rubric:: See also: :ref:`tapi_storage_client_init ` .. index:: pair: function; tapi_storage_client_mput .. _doxid-group__tapi__storage__client_1ga4cd2b6ab21c3c0299a9e8005f63161e5: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_storage_client_mput(:ref:`tapi_storage_client`* client, const :ref:`tapi_local_file`* local_file, const char* remote_file, bool recursive, bool force) Copy local files to the storage server location. Can be used for recursive copying of directories. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - client - Client handle. * - local_file - Local file name. * - remote_file - Remote file name or ``NULL`` to use the same. * - recursive - It has effect only if ``local_file`` is directory. If ``false`` then only files from mentioned directory will be copied. If ``true`` then additionally the all files from subdirectories will be copied. * - force - Force to replace existent content by the same. If ``false`` the existent content will not be rewriten by the same (lazy behaviour). .. rubric:: Returns: Status code. .. index:: pair: function; tapi_storage_client_mget .. _doxid-group__tapi__storage__client_1gaae020bd3e8bc79668831c1bdddbc56c5: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_storage_client_mget(:ref:`tapi_storage_client`* client, const char* remote_file, const char* local_file, bool recursive) Copy files from the storage server to local location. Can be used for recursive copying of directories. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - client - Client handle. * - remote_file - Remote file name. * - local_file - Local file name or ``NULL`` to use the same. * - recursive - It has effect only if ``remote_file`` is directory. If ``false`` then only files from mentioned directory will be copied. If ``true`` then additionally the all files from subdirectories will be copied. .. rubric:: Returns: Status code. Macros ------ .. index:: pair: define; TAPI_STORAGE_CLIENT_INIT .. _doxid-group__tapi__storage__client_1ga45663fa564f1b9d0227750ae5f752be1: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_STORAGE_CLIENT_INIT On-stack :ref:`tapi_storage_client ` structure initializer.