:orphan:

.. index:: pair: group; ONVMe target
.. _doxid-group__tapi__nvme__onvme__target:

ONVMe target
============

.. toctree::
	:hidden:

	struct_tapi_nvme_onvme_target_opts.rst
	struct_tapi_nvme_onvme_target_proc.rst

Overview
~~~~~~~~

API for control ONVMe target of NVMe Over Fabrics

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


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

	
	// typedefs

	typedef struct :ref:`tapi_nvme_onvme_target_opts<doxid-structtapi__nvme__onvme__target__opts>` :ref:`tapi_nvme_onvme_target_opts<doxid-group__tapi__nvme__onvme__target_1ga151ac32c1cba4309f7934212ae645505>`;
	typedef struct :ref:`tapi_nvme_onvme_target_proc<doxid-structtapi__nvme__onvme__target__proc>` :ref:`tapi_nvme_onvme_target_proc<doxid-group__tapi__nvme__onvme__target_1ga7d243b792615aa34effa8ac5175d4b09>`;

	// structs

	struct :ref:`tapi_nvme_onvme_target_opts<doxid-structtapi__nvme__onvme__target__opts>`;
	struct :ref:`tapi_nvme_onvme_target_proc<doxid-structtapi__nvme__onvme__target__proc>`;

	// global functions

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_nvme_onvme_target_init<doxid-group__tapi__nvme__onvme__target_1ga8a9a274998ee104e63e37927cc6b4b20>`(:ref:`tapi_nvme_target<doxid-structtapi__nvme__target>`* target, void* opts);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_nvme_onvme_target_setup<doxid-group__tapi__nvme__onvme__target_1ga9fdfb1b9642824a5379fd8a9011f4741>`(:ref:`tapi_nvme_target<doxid-structtapi__nvme__target>`* target);
	void :ref:`tapi_nvme_onvme_target_cleanup<doxid-group__tapi__nvme__onvme__target_1ga9464109b732a2ab58292e50f4655dbf3>`(:ref:`tapi_nvme_target<doxid-structtapi__nvme__target>`* target);
	void :ref:`tapi_nvme_onvme_target_fini<doxid-group__tapi__nvme__onvme__target_1ga68ef0afba55ab2448c76df24e7968e91>`(:ref:`tapi_nvme_target<doxid-structtapi__nvme__target>`* target);

	// macros

	#define :ref:`TAPI_NVME_ONVME_TARGET<doxid-group__tapi__nvme__onvme__target_1gae1eff330c4a255c2d424c2c6db1f4ea6>`
	#define :ref:`TAPI_NVME_ONVME_TARGET_METHODS<doxid-group__tapi__nvme__onvme__target_1gac7960d5db28e9f5ca21543679fc370dc>`
	#define :ref:`TAPI_NVME_ONVME_TARGET_OPTS_DEFAULTS<doxid-group__tapi__nvme__onvme__target_1ga1810f27d02d7d5fbee7dcca9e007d1f1>`
	#define :ref:`TAPI_NVME_ONVME_TARGET_PROC_DEFAULTS<doxid-group__tapi__nvme__onvme__target_1ga7bff281cf0ed1d2b2b4b173e94b8186b>`

.. _details-group__tapi__nvme__onvme__target:

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

API for control ONVMe target of NVMe Over Fabrics

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

Typedefs
--------

.. index:: pair: typedef; tapi_nvme_onvme_target_opts
.. _doxid-group__tapi__nvme__onvme__target_1ga151ac32c1cba4309f7934212ae645505:

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

	typedef struct :ref:`tapi_nvme_onvme_target_opts<doxid-structtapi__nvme__onvme__target__opts>` tapi_nvme_onvme_target_opts

ONVMe target opts

.. index:: pair: typedef; tapi_nvme_onvme_target_proc
.. _doxid-group__tapi__nvme__onvme__target_1ga7d243b792615aa34effa8ac5175d4b09:

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

	typedef struct :ref:`tapi_nvme_onvme_target_proc<doxid-structtapi__nvme__onvme__target__proc>` tapi_nvme_onvme_target_proc

ONVMe target context

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

.. index:: pair: function; tapi_nvme_onvme_target_init
.. _doxid-group__tapi__nvme__onvme__target_1ga8a9a274998ee104e63e37927cc6b4b20:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_nvme_onvme_target_init(:ref:`tapi_nvme_target<doxid-structtapi__nvme__target>`* target, void* opts)

Init ONVMe implementation of target



.. rubric:: Parameters:

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

	*
		- target

		- Target for setup

	*
		- opts

		- ONVMe target options



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_nvme_onvme_target_setup
.. _doxid-group__tapi__nvme__onvme__target_1ga9fdfb1b9642824a5379fd8a9011f4741:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_nvme_onvme_target_setup(:ref:`tapi_nvme_target<doxid-structtapi__nvme__target>`* target)

Setup ONVMe target



.. rubric:: Parameters:

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

	*
		- target

		- Target for setup



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_nvme_onvme_target_cleanup
.. _doxid-group__tapi__nvme__onvme__target_1ga9464109b732a2ab58292e50f4655dbf3:

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

	void tapi_nvme_onvme_target_cleanup(:ref:`tapi_nvme_target<doxid-structtapi__nvme__target>`* target)

Cleanup ONVMe target



.. rubric:: Parameters:

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

	*
		- target

		- Target for cleanup



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_nvme_onvme_target_fini
.. _doxid-group__tapi__nvme__onvme__target_1ga68ef0afba55ab2448c76df24e7968e91:

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

	void tapi_nvme_onvme_target_fini(:ref:`tapi_nvme_target<doxid-structtapi__nvme__target>`* target)

Deinit ONVMe target



.. rubric:: Parameters:

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

	*
		- target

		- Target for deinit



.. rubric:: Returns:

Status code

Macros
------

.. index:: pair: define; TAPI_NVME_ONVME_TARGET
.. _doxid-group__tapi__nvme__onvme__target_1gae1eff330c4a255c2d424c2c6db1f4ea6:

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

	#define TAPI_NVME_ONVME_TARGET

Default ONVMe target initialization

.. index:: pair: define; TAPI_NVME_ONVME_TARGET_METHODS
.. _doxid-group__tapi__nvme__onvme__target_1gac7960d5db28e9f5ca21543679fc370dc:

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

	#define TAPI_NVME_ONVME_TARGET_METHODS

ONVMe target methods

.. index:: pair: define; TAPI_NVME_ONVME_TARGET_OPTS_DEFAULTS
.. _doxid-group__tapi__nvme__onvme__target_1ga1810f27d02d7d5fbee7dcca9e007d1f1:

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

	#define TAPI_NVME_ONVME_TARGET_OPTS_DEFAULTS

ONVMe target opts defaults

.. index:: pair: define; TAPI_NVME_ONVME_TARGET_PROC_DEFAULTS
.. _doxid-group__tapi__nvme__onvme__target_1ga7bff281cf0ed1d2b2b4b173e94b8186b:

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

	#define TAPI_NVME_ONVME_TARGET_PROC_DEFAULTS

Default options for ONVMe target process