:orphan:

.. index:: pair: group; TAPI for RTE ring API remote calls
.. _doxid-group__te__lib__rpc__rte__ring:

TAPI for RTE ring API remote calls
==================================

.. toctree::
	:hidden:

Overview
~~~~~~~~




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

	
	// global functions

	rpc_rte_ring_p :ref:`rpc_rte_ring_create<doxid-group__te__lib__rpc__rte__ring_1ga5eeed3616036cf26c04eea32fa15e9ad>`(:ref:`rcf_rpc_server<doxid-structrcf__rpc__server>`* rpcs, const char* name, unsigned count, int socket_id, unsigned flags);
	void :ref:`rpc_rte_ring_free<doxid-group__te__lib__rpc__rte__ring_1gaa301efa5cc90d09bc32353d5900355fc>`(:ref:`rcf_rpc_server<doxid-structrcf__rpc__server>`* rpcs, rpc_rte_ring_p ring);
	int :ref:`rte_ring_enqueue_mbuf<doxid-group__te__lib__rpc__rte__ring_1ga62075607888b7785decf787eb44bc70f>`(:ref:`rcf_rpc_server<doxid-structrcf__rpc__server>`* rpcs, rpc_rte_ring_p ring, rpc_rte_mbuf_p m);
	rpc_rte_mbuf_p :ref:`rte_ring_dequeue_mbuf<doxid-group__te__lib__rpc__rte__ring_1ga1beb6a5ebe3384b5e4945b4128c9a04a>`(:ref:`rcf_rpc_server<doxid-structrcf__rpc__server>`* rpcs, rpc_rte_ring_p ring);

.. _details-group__te__lib__rpc__rte__ring:

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



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

.. index:: pair: function; rpc_rte_ring_create
.. _doxid-group__te__lib__rpc__rte__ring_1ga5eeed3616036cf26c04eea32fa15e9ad:

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

	rpc_rte_ring_p rpc_rte_ring_create(:ref:`rcf_rpc_server<doxid-structrcf__rpc__server>`* rpcs, const char* name, unsigned count, int socket_id, unsigned flags)

**rte_ring_create()** RPC



.. rubric:: Parameters:

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

	*
		- name

		- The name of the ring

	*
		- count

		- The size of the ring (must be a power of 2)

	*
		- socket_id

		- The socket identifier where the memory should be allocated

	*
		- flags

		- An OR of the following: (1U << TARPC_RTE_RING_F_SP_ENQ), (1U << TARPC_RTE_RING_F_SC_DEQ)



.. rubric:: Returns:

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

.. index:: pair: function; rpc_rte_ring_free
.. _doxid-group__te__lib__rpc__rte__ring_1gaa301efa5cc90d09bc32353d5900355fc:

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

	void rpc_rte_ring_free(:ref:`rcf_rpc_server<doxid-structrcf__rpc__server>`* rpcs, rpc_rte_ring_p ring)

**rte_ring_free()** RPC



.. rubric:: Parameters:

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

	*
		- ring

		- RTE ring pointer

.. index:: pair: function; rte_ring_enqueue_mbuf
.. _doxid-group__te__lib__rpc__rte__ring_1ga62075607888b7785decf787eb44bc70f:

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

	int rte_ring_enqueue_mbuf(:ref:`rcf_rpc_server<doxid-structrcf__rpc__server>`* rpcs, rpc_rte_ring_p ring, rpc_rte_mbuf_p m)

Enqueue an mbuf to RTE ring



.. rubric:: Parameters:

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

	*
		- ring

		- RTE ring pointer

	*
		- m

		- RTE mbuf pointer



.. rubric:: Returns:

``0`` on success; jumps out in case of failure

.. index:: pair: function; rte_ring_dequeue_mbuf
.. _doxid-group__te__lib__rpc__rte__ring_1ga1beb6a5ebe3384b5e4945b4128c9a04a:

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

	rpc_rte_mbuf_p rte_ring_dequeue_mbuf(:ref:`rcf_rpc_server<doxid-structrcf__rpc__server>`* rpcs, rpc_rte_ring_p ring)

Dequeue an mbuf from RTE ring



.. rubric:: Parameters:

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

	*
		- ring

		- RTE ring pointer



.. rubric:: Returns:

RTE mbuf pointer; doesn't jump out when pointer is ``NULL``