:orphan:

.. index:: pair: group; Test API to perform the generic operations over the storage
.. _doxid-group__tapi__storage__wrapper:

Test API to perform the generic operations over the storage
===========================================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Generic high level functions to work with storage. :ref:`More...<details-group__tapi__storage__wrapper>`


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

	
	// global functions

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_storage_bootstrap<doxid-group__tapi__storage__wrapper_1ga38c2ec3dd980fb6e4b1ce8c2b81de10c>`(:ref:`tapi_storage_client<doxid-structtapi__storage__client>`* client, const char* root, bool remove_root);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_storage_setup<doxid-group__tapi__storage__wrapper_1ga6ff08a0799a6a3d8a39c60d7f4e9ed3d>`(:ref:`tapi_storage_client<doxid-structtapi__storage__client>`* client, const char* root);

.. _details-group__tapi__storage__wrapper:

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

Generic high level functions to work with storage.

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

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

.. index:: pair: function; tapi_storage_bootstrap
.. _doxid-group__tapi__storage__wrapper_1ga38c2ec3dd980fb6e4b1ce8c2b81de10c:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_storage_bootstrap(:ref:`tapi_storage_client<doxid-structtapi__storage__client>`* client, const char* root, bool remove_root)

Clean up the storage from content.



.. rubric:: Parameters:

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

	*
		- client

		- Storage client handle.

	*
		- root

		- Root directory to bootstrap. May be ``NULL`` to use default '/'.

	*
		- remove_root

		- Enable delete a root directory as well (if ``true``).



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_storage_setup
.. _doxid-group__tapi__storage__wrapper_1ga6ff08a0799a6a3d8a39c60d7f4e9ed3d:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_storage_setup(:ref:`tapi_storage_client<doxid-structtapi__storage__client>`* client, const char* root)

Remove all existent content from remote storage and fill by another one. To update content it uses lazy-flag **STORAGE_UPLOAD_LAZY** obtained from configurator tree. If **STORAGE_UPLOAD_LAZY** is ``true`` then it will be applied only to dissimilar files of source and remote storages.



.. rubric:: Parameters:

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

	*
		- client

		- Storage client handle.

	*
		- root

		- Root directory to setup. Will be created if needed. May be ``NULL`` to use default '/'.



.. rubric:: Returns:

Status code.