:orphan:

.. index:: pair: group; TAPI for RTE MEMPOOL API remote calls
.. _doxid-group__te__lib__rpc__rte__mempool:

TAPI for RTE MEMPOOL API remote calls
=====================================

.. toctree::
	:hidden:

Overview
~~~~~~~~




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

	
	// global functions

	rpc_rte_mempool_p :ref:`rpc_rte_mempool_lookup<doxid-group__te__lib__rpc__rte__mempool_1ga89cc78d7e1843fbbab159cb7f0f1b2fb>`(:ref:`rcf_rpc_server<doxid-structrcf__rpc__server>`* rpcs, const char* name);
	unsigned int :ref:`rpc_rte_mempool_in_use_count<doxid-group__te__lib__rpc__rte__mempool_1ga74148856b2ef0b8bea9fbb998550e778>`(:ref:`rcf_rpc_server<doxid-structrcf__rpc__server>`* rpcs, rpc_rte_mempool_p mp);
	void :ref:`rpc_rte_mempool_free<doxid-group__te__lib__rpc__rte__mempool_1ga8a46c78942744b54857b0c0e266b2994>`(:ref:`rcf_rpc_server<doxid-structrcf__rpc__server>`* rpcs, rpc_rte_mempool_p mp);
	void :ref:`rpc_rte_mempool_free_all<doxid-group__te__lib__rpc__rte__mempool_1ga5fb9e3b2c5bdcfaf81682350c0b99c0d>`(:ref:`rcf_rpc_server<doxid-structrcf__rpc__server>`* rpcs);

.. _details-group__te__lib__rpc__rte__mempool:

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



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

.. index:: pair: function; rpc_rte_mempool_lookup
.. _doxid-group__te__lib__rpc__rte__mempool_1ga89cc78d7e1843fbbab159cb7f0f1b2fb:

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

	rpc_rte_mempool_p rpc_rte_mempool_lookup(:ref:`rcf_rpc_server<doxid-structrcf__rpc__server>`* rpcs, const char* name)

**rte_mempool_lookup()** RPC



.. rubric:: Parameters:

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

	*
		- name

		- RTE mempool name



.. rubric:: Returns:

RTE mempool pointer on success; jumps out when pointer is ``NULL``

.. index:: pair: function; rpc_rte_mempool_in_use_count
.. _doxid-group__te__lib__rpc__rte__mempool_1ga74148856b2ef0b8bea9fbb998550e778:

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

	unsigned int rpc_rte_mempool_in_use_count(:ref:`rcf_rpc_server<doxid-structrcf__rpc__server>`* rpcs, rpc_rte_mempool_p mp)

**rte_mempool_in_use_count()** RPC



.. rubric:: Parameters:

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

	*
		- mp

		- RTE mempool pointer



.. rubric:: Returns:

The number of elements which have been allocated from the mempool

.. index:: pair: function; rpc_rte_mempool_free
.. _doxid-group__te__lib__rpc__rte__mempool_1ga8a46c78942744b54857b0c0e266b2994:

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

	void rpc_rte_mempool_free(:ref:`rcf_rpc_server<doxid-structrcf__rpc__server>`* rpcs, rpc_rte_mempool_p mp)

**rte_mempool_free()** RPC



.. rubric:: Parameters:

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

	*
		- mp

		- Mempool to be freed

.. index:: pair: function; rpc_rte_mempool_free_all
.. _doxid-group__te__lib__rpc__rte__mempool_1ga5fb9e3b2c5bdcfaf81682350c0b99c0d:

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

	void rpc_rte_mempool_free_all(:ref:`rcf_rpc_server<doxid-structrcf__rpc__server>`* rpcs)

**rte_mempool_free_all()** RPC The function destroys ALL mempools by means of **rte_mempool_walk()** usage at RPC server side