:orphan:

.. index:: pair: group; I/O multiplexers
.. _doxid-group__tapi__iomux:

I/O multiplexers
================

.. toctree::
	:hidden:

	enum_tapi_iomux_evt.rst
	enum_tapi_iomux_type.rst
	struct_tapi_iomux_epoll_context.rst
	struct_tapi_iomux_evt_fd.rst
	struct_tapi_iomux_evts_list.rst
	struct_tapi_iomux_handle.rst
	struct_tapi_iomux_methods.rst
	struct_tapi_iomux_poll_context.rst
	struct_tapi_iomux_select_context.rst

Overview
~~~~~~~~

This API is dedicated to work with arbitrary I/O multiplexer functions in the single way. :ref:`More...<details-group__tapi__iomux>`


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

	
	// typedefs

	typedef enum :ref:`tapi_iomux_evt<doxid-group__tapi__iomux_1ga658ad12e16db86f0f4014d2c74915868>` :ref:`tapi_iomux_evt<doxid-group__tapi__iomux_1ga2193116db92c91f1b43f87d09d2e4850>`;
	typedef struct :ref:`tapi_iomux_handle<doxid-structtapi__iomux__handle>` :target:`tapi_iomux_handle<doxid-group__tapi__iomux_1ga9c92d5e3e4d287c3f9b5ed00d2f6d231>`;
	typedef struct :ref:`tapi_iomux_evt_fd<doxid-structtapi__iomux__evt__fd>` :target:`tapi_iomux_evt_fd<doxid-group__tapi__iomux_1gaa13792cd163825fa592192971886fa10>`;
	typedef void (*:ref:`tapi_iomux_method_create<doxid-group__tapi__iomux_1ga180a5524976719ba239c1dbf4b84328f>`)(tapi_iomux_handle *iomux);

	typedef void (*:ref:`tapi_iomux_method_add<doxid-group__tapi__iomux_1ga5938c2b27668b4293f27288a57a321dd>`)(
		tapi_iomux_handle *iomux,
		int fd,
		tapi_iomux_evt evt
		);

	typedef void (*:ref:`tapi_iomux_method_mod<doxid-group__tapi__iomux_1ga65909d833eec48912bc2774301a43e55>`)(
		tapi_iomux_handle *iomux,
		int fd,
		tapi_iomux_evt evt
		);

	typedef void (*:ref:`tapi_iomux_method_del<doxid-group__tapi__iomux_1ga006604259b5741e1de4d1f479386acd2>`)(
		tapi_iomux_handle *iomux,
		int fd
		);

	typedef int (*:ref:`tapi_iomux_method_call<doxid-group__tapi__iomux_1gaedc983145f092fa1ffe19e3aaf2c98fb>`)(
		tapi_iomux_handle *iomux,
		int timeout,
		tapi_iomux_evt_fd **revts
		);

	typedef void (*:ref:`tapi_iomux_method_destroy<doxid-group__tapi__iomux_1ga8829712ddf2bd8c5e682355b5d8b6897>`)(tapi_iomux_handle *iomux);
	typedef struct :ref:`tapi_iomux_methods<doxid-structtapi__iomux__methods>` :ref:`tapi_iomux_methods<doxid-group__tapi__iomux_1ga89f7d501e910ed276e448343326711ed>`;
	typedef struct :ref:`tapi_iomux_select_context<doxid-structtapi__iomux__select__context>` :ref:`tapi_iomux_select_context<doxid-group__tapi__iomux_1gae6973dbd7b838e33fe4cb67265cc0421>`;
	typedef struct :ref:`tapi_iomux_poll_context<doxid-structtapi__iomux__poll__context>` :ref:`tapi_iomux_poll_context<doxid-group__tapi__iomux_1gad3821438a0407d51d11c255e1e9e1a8d>`;
	typedef struct :ref:`tapi_iomux_epoll_context<doxid-structtapi__iomux__epoll__context>` :ref:`tapi_iomux_epoll_context<doxid-group__tapi__iomux_1ga52cddf216fa651dcd0e714a5fd57a687>`;
	typedef struct :ref:`tapi_iomux_evts_list<doxid-structtapi__iomux__evts__list>` :ref:`tapi_iomux_evts_list<doxid-group__tapi__iomux_1ga587f3cb1412c00557fb4072af9012692>`;
	typedef struct tapi_iomux_evts_list_h :target:`tapi_iomux_evts_list_h<doxid-group__tapi__iomux_1ga2d5d043305a75b53572c427c8472afd9>`;

	// enums

	enum :ref:`tapi_iomux_evt<doxid-group__tapi__iomux_1ga658ad12e16db86f0f4014d2c74915868>`;
	enum :ref:`tapi_iomux_type<doxid-group__tapi__iomux_1ga9b3280d2f17e00f87cfe53daed747d10>`;

	// structs

	struct :ref:`tapi_iomux_epoll_context<doxid-structtapi__iomux__epoll__context>`;
	struct :ref:`tapi_iomux_evt_fd<doxid-structtapi__iomux__evt__fd>`;
	struct :ref:`tapi_iomux_evts_list<doxid-structtapi__iomux__evts__list>`;
	struct :ref:`tapi_iomux_handle<doxid-structtapi__iomux__handle>`;
	struct :ref:`tapi_iomux_methods<doxid-structtapi__iomux__methods>`;
	struct :ref:`tapi_iomux_poll_context<doxid-structtapi__iomux__poll__context>`;
	struct :ref:`tapi_iomux_select_context<doxid-structtapi__iomux__select__context>`;

	// global functions

	:ref:`RPCBITMAP2STR<doxid-group__tapi__iomux_1gaab56a426a3db131d5ec30496e1b791d6>`(tapi_iomux_event, :ref:`IOMUX_EVENT_MAPPING_LIST<doxid-group__tapi__iomux_1gad59c00e9e251a4e3e8d3f0a2379327b0>`);
	:ref:`tapi_iomux_type<doxid-group__tapi__iomux_1ga9b3280d2f17e00f87cfe53daed747d10>` :ref:`tapi_iomux_call_str2en<doxid-group__tapi__iomux_1ga88332dd82eca1380a959c4d7a1d24f5e>`(const char* iomux);
	const char* :ref:`tapi_iomux_call_en2str<doxid-group__tapi__iomux_1gab0429dfa701867255a03999381f28b8a>`(:ref:`tapi_iomux_type<doxid-group__tapi__iomux_1ga9b3280d2f17e00f87cfe53daed747d10>` iomux_type);
	short int :ref:`tapi_iomux_evt_to_poll<doxid-group__tapi__iomux_1gae27071adcfc040c9e222afe4e8c0b192>`(:ref:`tapi_iomux_evt<doxid-group__tapi__iomux_1ga658ad12e16db86f0f4014d2c74915868>` iomux_evt_mask);
	uint32_t :ref:`tapi_iomux_evt_to_epoll<doxid-group__tapi__iomux_1ga407cd0c813d748bd46fa59c4928581cf>`(:ref:`tapi_iomux_evt<doxid-group__tapi__iomux_1ga658ad12e16db86f0f4014d2c74915868>` iomux_evt_mask);
	:ref:`tapi_iomux_evt<doxid-group__tapi__iomux_1ga658ad12e16db86f0f4014d2c74915868>` :ref:`tapi_iomux_poll_to_evt<doxid-group__tapi__iomux_1gaf63ac5263b17f55d4c9d675d2f0d79ae>`(short int poll_evt_mask);
	:ref:`tapi_iomux_evt<doxid-group__tapi__iomux_1ga658ad12e16db86f0f4014d2c74915868>` :ref:`tapi_iomux_epoll_to_evt<doxid-group__tapi__iomux_1ga3ba4e21842cfbfc75e805ef2a64b7f4b>`(uint32_t epoll_evt_mask);
	:target:`SLIST_HEAD<doxid-group__tapi__iomux_1gac5a6c95a31e1bda608baebd0c72a16a2>`(tapi_iomux_evts_list_h, :ref:`tapi_iomux_evts_list<doxid-structtapi__iomux__evts__list>`);
	:ref:`tapi_iomux_handle<doxid-structtapi__iomux__handle>`* :ref:`tapi_iomux_create<doxid-group__tapi__iomux_1ga991499424ad79bf049e1b54a9e4b3201>`(:ref:`rcf_rpc_server<doxid-structrcf__rpc__server>`* rpcs, :ref:`tapi_iomux_type<doxid-group__tapi__iomux_1ga9b3280d2f17e00f87cfe53daed747d10>` type);
	void :ref:`tapi_iomux_add<doxid-group__tapi__iomux_1ga88b62edc1767f3c339315967c8148ed0>`(:ref:`tapi_iomux_handle<doxid-structtapi__iomux__handle>`* iomux, int fd, :ref:`tapi_iomux_evt<doxid-group__tapi__iomux_1ga658ad12e16db86f0f4014d2c74915868>` evt);
	void :ref:`tapi_iomux_mod<doxid-group__tapi__iomux_1ga0885d28b8200f2b3f6974b2e06605140>`(:ref:`tapi_iomux_handle<doxid-structtapi__iomux__handle>`* iomux, int fd, :ref:`tapi_iomux_evt<doxid-group__tapi__iomux_1ga658ad12e16db86f0f4014d2c74915868>` evt);
	void :ref:`tapi_iomux_del<doxid-group__tapi__iomux_1gac667bfc68c4ab9502caef4057d770865>`(:ref:`tapi_iomux_handle<doxid-structtapi__iomux__handle>`* iomux, int fd);
	void :ref:`tapi_iomux_set_sigmask<doxid-group__tapi__iomux_1ga159022ba50140dbbdd159a884c35d464>`(:ref:`tapi_iomux_handle<doxid-structtapi__iomux__handle>`* iomux, rpc_sigset_p sigmask);
	int :ref:`tapi_iomux_call<doxid-group__tapi__iomux_1ga44732beed8eabfd097e938ff37a7a23c>`(:ref:`tapi_iomux_handle<doxid-structtapi__iomux__handle>`* iomux, int timeout, :ref:`tapi_iomux_evt_fd<doxid-structtapi__iomux__evt__fd>`** revts);
	int :ref:`tapi_iomux_pcall<doxid-group__tapi__iomux_1ga3c21d30e87aefc91bb5dd45741dd7b10>`(:ref:`tapi_iomux_handle<doxid-structtapi__iomux__handle>`* iomux, int timeout, rpc_sigset_p sigmask, :ref:`tapi_iomux_evt_fd<doxid-structtapi__iomux__evt__fd>`** revts);
	void :ref:`tapi_iomux_destroy<doxid-group__tapi__iomux_1ga0ca74a7e3a609f091c30892f0a434a43>`(:ref:`tapi_iomux_handle<doxid-structtapi__iomux__handle>`* iomux);
	:ref:`tapi_iomux_evt_fd<doxid-structtapi__iomux__evt__fd>`* :ref:`tapi_iomux_epoll_get_events<doxid-group__tapi__iomux_1ga2ac86cd1d779177144c2cd7b8f82188e>`(:ref:`tapi_iomux_handle<doxid-structtapi__iomux__handle>`* iomux, struct :ref:`rpc_epoll_event<doxid-structrpc__epoll__event>`* events, int evts_num);

	// macros

	#define :ref:`BIT_MAP_ENTRY<doxid-group__tapi__iomux_1gacc9b8f0a7a89a8f36fcc32bd63808cf5>`(entry_val_)
	#define :ref:`IOMUX_EVENT_MAPPING_LIST<doxid-group__tapi__iomux_1gad59c00e9e251a4e3e8d3f0a2379327b0>`
	#define :ref:`TAPI_IOMUX_MAPPING_LIST<doxid-group__tapi__iomux_1gaaf69c5741429458bff47d71eb5f0aec3>`
	#define :ref:`TAPI_IOMUX_MAX<doxid-group__tapi__iomux_1gab31298378baa93de3c1b75e996257828>`
	#define :ref:`TAPI_IOMUX_MIN<doxid-group__tapi__iomux_1ga05df78791176707d96200dfe4c5854f9>`
	#define :ref:`TEST_GET_TE_IOMUX_FUNC<doxid-group__tapi__iomux_1gabc6c3c5460ab1bd89ac415694459cfc3>`(var_name_)

.. _details-group__tapi__iomux:

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

This API is dedicated to work with arbitrary I/O multiplexer functions in the single way.

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

Typedefs
--------

.. index:: pair: typedef; tapi_iomux_evt
.. _doxid-group__tapi__iomux_1ga2193116db92c91f1b43f87d09d2e4850:

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

	typedef enum :ref:`tapi_iomux_evt<doxid-group__tapi__iomux_1ga658ad12e16db86f0f4014d2c74915868>` tapi_iomux_evt

Type of events used in iomux API.

.. index:: pair: typedef; tapi_iomux_method_create
.. _doxid-group__tapi__iomux_1ga180a5524976719ba239c1dbf4b84328f:

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

	typedef void (*tapi_iomux_method_create)(tapi_iomux_handle *iomux)

Function prototype to create a multiplexer.



.. rubric:: Parameters:

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

	*
		- iomux

		- The multiplexer handle.

.. index:: pair: typedef; tapi_iomux_method_add
.. _doxid-group__tapi__iomux_1ga5938c2b27668b4293f27288a57a321dd:

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

	typedef void (*tapi_iomux_method_add)(
		tapi_iomux_handle *iomux,
		int fd,
		tapi_iomux_evt evt
		)

Function prototype to add a file descriptor to a multiplexer set.



.. rubric:: Parameters:

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

	*
		- iomux

		- The multiplexer handle.

	*
		- fd

		- The file descriptor to add to the multiplexer set.

	*
		- evt

		- Requested events.

.. index:: pair: typedef; tapi_iomux_method_mod
.. _doxid-group__tapi__iomux_1ga65909d833eec48912bc2774301a43e55:

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

	typedef void (*tapi_iomux_method_mod)(
		tapi_iomux_handle *iomux,
		int fd,
		tapi_iomux_evt evt
		)

Function prototype to modify a file descriptor events.



.. rubric:: Parameters:

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

	*
		- iomux

		- The multiplexer handle.

	*
		- fd

		- The file descriptor to modify events for.

	*
		- evt

		- New events.

.. index:: pair: typedef; tapi_iomux_method_del
.. _doxid-group__tapi__iomux_1ga006604259b5741e1de4d1f479386acd2:

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

	typedef void (*tapi_iomux_method_del)(
		tapi_iomux_handle *iomux,
		int fd
		)

Function prototype to delete a file descriptor from a multiplexer set.



.. rubric:: Parameters:

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

	*
		- iomux

		- The multiplexer handle.

	*
		- fd

		- The file descriptor which should be deleted.

.. index:: pair: typedef; tapi_iomux_method_call
.. _doxid-group__tapi__iomux_1gaedc983145f092fa1ffe19e3aaf2c98fb:

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

	typedef int (*tapi_iomux_method_call)(
		tapi_iomux_handle *iomux,
		int timeout,
		tapi_iomux_evt_fd **revts
		)

Function prototype to perform a multiplexer call.



.. rubric:: Parameters:

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

	*
		- iomux

		- The multiplexer handle.

	*
		- timeout

		- Timeout to block in the call in milliseconds.

	*
		- revts

		- Returned events.



.. rubric:: Returns:

Events number or ``-1`` in case of fail, actualy return code is forwarded from the system multiplexer function call.

.. index:: pair: typedef; tapi_iomux_method_destroy
.. _doxid-group__tapi__iomux_1ga8829712ddf2bd8c5e682355b5d8b6897:

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

	typedef void (*tapi_iomux_method_destroy)(tapi_iomux_handle *iomux)

Function prototype to destroy a multiplexer.



.. rubric:: Parameters:

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

	*
		- iomux

		- The multiplexer handle.

.. index:: pair: typedef; tapi_iomux_methods
.. _doxid-group__tapi__iomux_1ga89f7d501e910ed276e448343326711ed:

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

	typedef struct :ref:`tapi_iomux_methods<doxid-structtapi__iomux__methods>` tapi_iomux_methods

A multiplexer methods.

.. index:: pair: typedef; tapi_iomux_select_context
.. _doxid-group__tapi__iomux_1gae6973dbd7b838e33fe4cb67265cc0421:

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

	typedef struct :ref:`tapi_iomux_select_context<doxid-structtapi__iomux__select__context>` tapi_iomux_select_context

Context data for ``select()`` API.

.. index:: pair: typedef; tapi_iomux_poll_context
.. _doxid-group__tapi__iomux_1gad3821438a0407d51d11c255e1e9e1a8d:

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

	typedef struct :ref:`tapi_iomux_poll_context<doxid-structtapi__iomux__poll__context>` tapi_iomux_poll_context

Context data for ``poll()`` API.

.. index:: pair: typedef; tapi_iomux_epoll_context
.. _doxid-group__tapi__iomux_1ga52cddf216fa651dcd0e714a5fd57a687:

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

	typedef struct :ref:`tapi_iomux_epoll_context<doxid-structtapi__iomux__epoll__context>` tapi_iomux_epoll_context

Context data for ``epoll()`` API.

.. index:: pair: typedef; tapi_iomux_evts_list
.. _doxid-group__tapi__iomux_1ga587f3cb1412c00557fb4072af9012692:

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

	typedef struct :ref:`tapi_iomux_evts_list<doxid-structtapi__iomux__evts__list>` tapi_iomux_evts_list

Events list for internal iomux API using.

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

.. index:: pair: function; RPCBITMAP2STR
.. _doxid-group__tapi__iomux_1gaab56a426a3db131d5ec30496e1b791d6:

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

	RPCBITMAP2STR(tapi_iomux_event, :ref:`IOMUX_EVENT_MAPPING_LIST<doxid-group__tapi__iomux_1gad59c00e9e251a4e3e8d3f0a2379327b0>`)

tapi_iomux_event_rpc2str()

.. index:: pair: function; tapi_iomux_call_str2en
.. _doxid-group__tapi__iomux_1ga88332dd82eca1380a959c4d7a1d24f5e:

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

	:ref:`tapi_iomux_type<doxid-group__tapi__iomux_1ga9b3280d2f17e00f87cfe53daed747d10>` tapi_iomux_call_str2en(const char* iomux)

Convert string name of iomux function to enum constant.



.. rubric:: Parameters:

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

	*
		- iomux

		- name of function: "select", "pselect", or "poll".



.. rubric:: Returns:

respective value from tapi_iomux_type enum.

.. index:: pair: function; tapi_iomux_call_en2str
.. _doxid-group__tapi__iomux_1gab0429dfa701867255a03999381f28b8a:

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

	const char* tapi_iomux_call_en2str(:ref:`tapi_iomux_type<doxid-group__tapi__iomux_1ga9b3280d2f17e00f87cfe53daed747d10>` iomux_type)

Convert constant from :ref:`tapi_iomux_type <doxid-group__tapi__iomux_1ga9b3280d2f17e00f87cfe53daed747d10>` to human string



.. rubric:: Parameters:

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

	*
		- iomux_type

		- Value to be converted



.. rubric:: Returns:

static character string

.. index:: pair: function; tapi_iomux_evt_to_poll
.. _doxid-group__tapi__iomux_1gae27071adcfc040c9e222afe4e8c0b192:

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

	short int tapi_iomux_evt_to_poll(:ref:`tapi_iomux_evt<doxid-group__tapi__iomux_1ga658ad12e16db86f0f4014d2c74915868>` iomux_evt_mask)

Convert bitmask constructed with constants from :ref:`tapi_iomux_evt <doxid-group__tapi__iomux_1ga658ad12e16db86f0f4014d2c74915868>` type to bitmask constructed with standard POLL\* macros from poll.h



.. rubric:: Parameters:

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

	*
		- iomux_evt_mask

		- Event bitmask from :ref:`tapi_iomux_evt <doxid-group__tapi__iomux_1ga658ad12e16db86f0f4014d2c74915868>` constants.



.. rubric:: Returns:

event bitmask from POLL\* constants.

.. index:: pair: function; tapi_iomux_evt_to_epoll
.. _doxid-group__tapi__iomux_1ga407cd0c813d748bd46fa59c4928581cf:

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

	uint32_t tapi_iomux_evt_to_epoll(:ref:`tapi_iomux_evt<doxid-group__tapi__iomux_1ga658ad12e16db86f0f4014d2c74915868>` iomux_evt_mask)

Convert bitmask constructed with constants from :ref:`tapi_iomux_evt <doxid-group__tapi__iomux_1ga658ad12e16db86f0f4014d2c74915868>` type to bitmask constructed with standard EPOLL\* macros from epoll.h



.. rubric:: Parameters:

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

	*
		- iomux_evt_mask

		- Event bitmask from :ref:`tapi_iomux_evt <doxid-group__tapi__iomux_1ga658ad12e16db86f0f4014d2c74915868>` constants.



.. rubric:: Returns:

event bitmask from EPOLL\* constants.

.. index:: pair: function; tapi_iomux_poll_to_evt
.. _doxid-group__tapi__iomux_1gaf63ac5263b17f55d4c9d675d2f0d79ae:

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

	:ref:`tapi_iomux_evt<doxid-group__tapi__iomux_1ga658ad12e16db86f0f4014d2c74915868>` tapi_iomux_poll_to_evt(short int poll_evt_mask)

Convert bitmask constructed with standard POLL\* macros from poll.h to bitmask constructed with constants from :ref:`tapi_iomux_evt <doxid-group__tapi__iomux_1ga658ad12e16db86f0f4014d2c74915868>` type.



.. rubric:: Parameters:

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

	*
		- poll_evt_mask

		- event bitmask from POLL\* constants.



.. rubric:: Returns:

event bitmask from :ref:`tapi_iomux_evt <doxid-group__tapi__iomux_1ga658ad12e16db86f0f4014d2c74915868>` constants.

.. index:: pair: function; tapi_iomux_epoll_to_evt
.. _doxid-group__tapi__iomux_1ga3ba4e21842cfbfc75e805ef2a64b7f4b:

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

	:ref:`tapi_iomux_evt<doxid-group__tapi__iomux_1ga658ad12e16db86f0f4014d2c74915868>` tapi_iomux_epoll_to_evt(uint32_t epoll_evt_mask)

Convert bitmask constructed with standard EPOLL\* macros from epoll.h to bitmask constructed with constants from :ref:`tapi_iomux_evt <doxid-group__tapi__iomux_1ga658ad12e16db86f0f4014d2c74915868>` type.



.. rubric:: Parameters:

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

	*
		- epoll_evt_mask

		- event bitmask from EPOLL\* constants.



.. rubric:: Returns:

event bitmask from :ref:`tapi_iomux_evt <doxid-group__tapi__iomux_1ga658ad12e16db86f0f4014d2c74915868>` constants.

.. index:: pair: function; tapi_iomux_create
.. _doxid-group__tapi__iomux_1ga991499424ad79bf049e1b54a9e4b3201:

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

	:ref:`tapi_iomux_handle<doxid-structtapi__iomux__handle>`* tapi_iomux_create(:ref:`rcf_rpc_server<doxid-structrcf__rpc__server>`* rpcs, :ref:`tapi_iomux_type<doxid-group__tapi__iomux_1ga9b3280d2f17e00f87cfe53daed747d10>` type)

Create a multiplexer.



.. rubric:: Parameters:

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

	*
		- rpcs

		- RPC server handle.

	*
		- type

		- The multiplexer type.



.. rubric:: Returns:

The multiplexer handle.

.. index:: pair: function; tapi_iomux_add
.. _doxid-group__tapi__iomux_1ga88b62edc1767f3c339315967c8148ed0:

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

	void tapi_iomux_add(:ref:`tapi_iomux_handle<doxid-structtapi__iomux__handle>`* iomux, int fd, :ref:`tapi_iomux_evt<doxid-group__tapi__iomux_1ga658ad12e16db86f0f4014d2c74915868>` evt)

Add a file descriptor to a multiplexer set.



.. rubric:: Parameters:

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

	*
		- iomux

		- The multiplexer handle.

	*
		- fd

		- The file descriptor to add to the multiplexer set.

	*
		- evt

		- Requested events.

.. index:: pair: function; tapi_iomux_mod
.. _doxid-group__tapi__iomux_1ga0885d28b8200f2b3f6974b2e06605140:

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

	void tapi_iomux_mod(:ref:`tapi_iomux_handle<doxid-structtapi__iomux__handle>`* iomux, int fd, :ref:`tapi_iomux_evt<doxid-group__tapi__iomux_1ga658ad12e16db86f0f4014d2c74915868>` evt)

Modify a file descriptor events.



.. rubric:: Parameters:

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

	*
		- iomux

		- The multiplexer handle.

	*
		- fd

		- The file descriptor to modify events for.

	*
		- evt

		- New events.

.. index:: pair: function; tapi_iomux_del
.. _doxid-group__tapi__iomux_1gac667bfc68c4ab9502caef4057d770865:

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

	void tapi_iomux_del(:ref:`tapi_iomux_handle<doxid-structtapi__iomux__handle>`* iomux, int fd)

Delete a file descriptor from a multiplexer set.



.. rubric:: Parameters:

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

	*
		- iomux

		- The multiplexer handle.

	*
		- fd

		- The file descriptor which should be deleted.

.. index:: pair: function; tapi_iomux_set_sigmask
.. _doxid-group__tapi__iomux_1ga159022ba50140dbbdd159a884c35d464:

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

	void tapi_iomux_set_sigmask(:ref:`tapi_iomux_handle<doxid-structtapi__iomux__handle>`* iomux, rpc_sigset_p sigmask)

Specify a signal mask for a multiplexer.

This call makes sense for iomux types ``TAPI_IOMUX_PSELECT``, ``TAPI_IOMUX_PPOLL``, ``TAPI_IOMUX_EPOLL_PWAIT`` and ``TAPI_IOMUX_EPOLL_PWAIT2``, the signal mask is ignored by other muxers.



.. rubric:: Parameters:

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

	*
		- iomux

		- The multiplexer handle.

	*
		- sigmask

		- RPC pointer to the signal mask.

.. index:: pair: function; tapi_iomux_call
.. _doxid-group__tapi__iomux_1ga44732beed8eabfd097e938ff37a7a23c:

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

	int tapi_iomux_call(:ref:`tapi_iomux_handle<doxid-structtapi__iomux__handle>`* iomux, int timeout, :ref:`tapi_iomux_evt_fd<doxid-structtapi__iomux__evt__fd>`** revts)

Perform a multiplexer call.

The call can be done expecting a fail using ``RPC_AWAIT_IUT_ERROR`` as for usual RPC call, return code of the muxer call is forwarded and returned by the function.

This call can be executed in non-blocking mode using ``RCF_RPC_CALL`` as usual RPC call.



.. rubric:: Parameters:

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

	*
		- iomux

		- The multiplexer handle.

	*
		- timeout

		- Timeout to block in the call in milliseconds.

	*
		- revts

		- Returned events.



.. rubric:: Returns:

Events number or ``-1`` in case of fail, actualy return code is forwarded from the system multiplexer function call.

.. index:: pair: function; tapi_iomux_pcall
.. _doxid-group__tapi__iomux_1ga3c21d30e87aefc91bb5dd45741dd7b10:

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

	int tapi_iomux_pcall(:ref:`tapi_iomux_handle<doxid-structtapi__iomux__handle>`* iomux, int timeout, rpc_sigset_p sigmask, :ref:`tapi_iomux_evt_fd<doxid-structtapi__iomux__evt__fd>`** revts)

Perform a multiplexer call specifying a signal mask.

See also ``:ref:`tapi_iomux_call() <doxid-group__tapi__iomux_1ga44732beed8eabfd097e938ff37a7a23c>``` description for details.



.. rubric:: Parameters:

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

	*
		- iomux

		- The multiplexer handle.

	*
		- timeout

		- Timeout to block in the call in milliseconds.

	*
		- sigmask

		- Signal mask.

	*
		- revts

		- Returned events.



.. rubric:: Returns:

Events number or ``-1`` in case of fail, actualy return code is forwarded from the system multiplexer function call.

.. index:: pair: function; tapi_iomux_destroy
.. _doxid-group__tapi__iomux_1ga0ca74a7e3a609f091c30892f0a434a43:

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

	void tapi_iomux_destroy(:ref:`tapi_iomux_handle<doxid-structtapi__iomux__handle>`* iomux)

Destroy a multiplexer.



.. rubric:: Parameters:

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

	*
		- iomux

		- The multiplexer handle.

.. index:: pair: function; tapi_iomux_epoll_get_events
.. _doxid-group__tapi__iomux_1ga2ac86cd1d779177144c2cd7b8f82188e:

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

	:ref:`tapi_iomux_evt_fd<doxid-structtapi__iomux__evt__fd>`* tapi_iomux_epoll_get_events(:ref:`tapi_iomux_handle<doxid-structtapi__iomux__handle>`* iomux, struct :ref:`rpc_epoll_event<doxid-structrpc__epoll__event>`* events, int evts_num)

Process returned events by ``epoll_wait()``, ``epoll_pwait()`` or ``epoll_pwait2()`` call, convert and save them in the iomux context.



.. rubric:: Parameters:

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

	*
		- iomux

		- The multiplexer handle.

	*
		- events

		- Returned epoll events array.

	*
		- evts_num

		- The array length.



.. rubric:: Returns:

Returned events array converted to the generic representation.

Macros
------

.. index:: pair: define; BIT_MAP_ENTRY
.. _doxid-group__tapi__iomux_1gacc9b8f0a7a89a8f36fcc32bd63808cf5:

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

	#define BIT_MAP_ENTRY(entry_val_)

Define one entry in the list of maping entries

.. index:: pair: define; IOMUX_EVENT_MAPPING_LIST
.. _doxid-group__tapi__iomux_1gad59c00e9e251a4e3e8d3f0a2379327b0:

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

	#define IOMUX_EVENT_MAPPING_LIST

List of mapping numerical value to string for 'tapi_iomux_evt'

.. index:: pair: define; TAPI_IOMUX_MAPPING_LIST
.. _doxid-group__tapi__iomux_1gaaf69c5741429458bff47d71eb5f0aec3:

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

	#define TAPI_IOMUX_MAPPING_LIST

The list of values allowed for test parameter defining iomux function.

.. index:: pair: define; TAPI_IOMUX_MAX
.. _doxid-group__tapi__iomux_1gab31298378baa93de3c1b75e996257828:

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

	#define TAPI_IOMUX_MAX

Maximum supported iomux type value.

.. index:: pair: define; TAPI_IOMUX_MIN
.. _doxid-group__tapi__iomux_1ga05df78791176707d96200dfe4c5854f9:

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

	#define TAPI_IOMUX_MIN

Minimum supported iomux type value.

.. index:: pair: define; TEST_GET_TE_IOMUX_FUNC
.. _doxid-group__tapi__iomux_1gabc6c3c5460ab1bd89ac415694459cfc3:

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

	#define TEST_GET_TE_IOMUX_FUNC(var_name_)

Get the value of parameter defining iomux function.



.. rubric:: Parameters:

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

	*
		- var_name\_

		- Name of the variable used to get the value of "var_name\_" parameter.