:orphan:

.. index:: pair: group; Test API to use memory-related functions conveniently
.. _doxid-group__tapi__mem:

Test API to use memory-related functions conveniently
=====================================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Implementation of API to use memory-related functions in a convenient way

Copyright (C) 2004-2022 OKTET Labs Ltd. :ref:`More...<details-group__tapi__mem>`


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

	
	// global functions

	void* :ref:`tapi_malloc<doxid-group__tapi__mem_1ga1b16cbb597a73a05f7f1e1ab3b7d1123>`(size_t size);
	void* :ref:`tapi_malloc_or_null<doxid-group__tapi__mem_1ga7847d09973f0c9011b2468ddcf2619c1>`(size_t size);
	void* :ref:`tapi_calloc<doxid-group__tapi__mem_1gaf5b7236570dbd1a66234b689f7e83d9f>`(size_t nmemb, size_t size);
	void* :ref:`tapi_realloc<doxid-group__tapi__mem_1ga5d59c86c55334234043c7b7daa6142c2>`(void* ptr, size_t size);
	void* :ref:`tapi_memdup<doxid-group__tapi__mem_1ga8b37d52200fdfa3908e599cb62e9db23>`(const void* ptr, size_t size);
	char* :ref:`tapi_strdup<doxid-group__tapi__mem_1gad74118aaa322a780714488ba1618585e>`(const char* s);
	char* :ref:`tapi_strndup<doxid-group__tapi__mem_1gaf6e4f377067228851cc62863285090c2>`(const char* s, size_t size);

.. _details-group__tapi__mem:

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

Implementation of API to use memory-related functions in a convenient way

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

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

.. index:: pair: function; tapi_malloc
.. _doxid-group__tapi__mem_1ga1b16cbb597a73a05f7f1e1ab3b7d1123:

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

	void* tapi_malloc(size_t size)

**malloc()** wrapper which performs allocation status check internally



.. rubric:: Parameters:

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

	*
		- size

		- Size of memory to allocate



.. rubric:: Returns:

Pointer to an allocated memory (never returns ``NULL``)

.. index:: pair: function; tapi_malloc_or_null
.. _doxid-group__tapi__mem_1ga7847d09973f0c9011b2468ddcf2619c1:

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

	void* tapi_malloc_or_null(size_t size)

``malloc()`` wrapper which performs allocation status check internally.



.. rubric:: Parameters:

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

	*
		- size

		- Size of memory to allocate.



.. rubric:: Returns:

Pointer to an allocated memory or ``NULL`` if ``size`` is ``0`` and never ``NULL`` othewise.

.. index:: pair: function; tapi_calloc
.. _doxid-group__tapi__mem_1gaf5b7236570dbd1a66234b689f7e83d9f:

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

	void* tapi_calloc(size_t nmemb, size_t size)

**calloc()** wrapper which performs allocation status check internally



.. rubric:: Parameters:

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

	*
		- nmemb

		- Number of memory elements to allocate

	*
		- size

		- Size of an element



.. rubric:: Returns:

Pointer to an allocated memory (never returns ``NULL``)

.. index:: pair: function; tapi_realloc
.. _doxid-group__tapi__mem_1ga5d59c86c55334234043c7b7daa6142c2:

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

	void* tapi_realloc(void* ptr, size_t size)

**realloc()** wrapper which performs allocation status check internally



.. rubric:: Parameters:

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

	*
		- ptr

		- Pointer to a memory block to re-allocate

	*
		- size

		- New size for a memory block to re-allocate



.. rubric:: Returns:

Pointer to re-allocated memory (never returns ``NULL``)

.. index:: pair: function; tapi_memdup
.. _doxid-group__tapi__mem_1ga8b37d52200fdfa3908e599cb62e9db23:

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

	void* tapi_memdup(const void* ptr, size_t size)

**malloc()** + memcpy() wrapper designed to simplify memory copying



.. rubric:: Parameters:

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

	*
		- ptr

		- Source memory pointer

	*
		- size

		- Size of the memory block pointed by ``ptr``



.. rubric:: Returns:

Pointer to a memory block copy (never returns ``NULL``)

.. index:: pair: function; tapi_strdup
.. _doxid-group__tapi__mem_1gad74118aaa322a780714488ba1618585e:

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

	char* tapi_strdup(const char* s)

**strdup()** wrapper which performs duplication status check internally



.. rubric:: Parameters:

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

	*
		- s

		- Pointer to a source string to be duplicated



.. rubric:: Returns:

Pointer to a string copy (never returns ``NULL``)

.. index:: pair: function; tapi_strndup
.. _doxid-group__tapi__mem_1gaf6e4f377067228851cc62863285090c2:

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

	char* tapi_strndup(const char* s, size_t size)

**strndup()** wrapper which performs duplication status check internally



.. rubric:: Parameters:

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

	*
		- s

		- Pointer to a source string to be duplicated

	*
		- size

		- Counts of bytes to copy from a source string



.. rubric:: Returns:

Pointer to a string copy (never returns ``NULL``)