:orphan:

.. index:: pair: group; Test Agents: Portable Commands Handler
.. _doxid-group__rcf__pch:

Test Agents: Portable Commands Handler
======================================

.. toctree::
	:hidden:

	group_rcf_pch_rsrc.rst

Overview
~~~~~~~~



|	:ref:`API: Shared TA resources<doxid-group__rcf__pch__rsrc>`



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

	
	// global functions

	int :ref:`rcf_pch_run<doxid-group__rcf__pch_1ga674454c23e4d97f6597fedb057aaf835>`(const char* confstr, const char* info);
	void :ref:`rcf_pch_get_id<doxid-group__rcf__pch_1gaa7ad8c009e665353d909c8257006e950>`(char* id);
	void :ref:`rcf_pch_rpc_init<doxid-group__rcf__pch_1ga9a40137dd5d81703caa11f06c2de0182>`(const char* tmp_path);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`rpcserver_plugin_enable<doxid-group__rcf__pch_1ga9168424fe0ded5fa118720222654dc25>`(const char* install, const char* action, const char* uninstall);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`rpcserver_plugin_disable<doxid-group__rcf__pch_1ga67c4da473ca130f94908ac668f623ca5>`(void);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`rcf_pch_find_node<doxid-group__rcf__pch_1ga7119ee0a530695a10651bf2f994be8a3>`(const char* oid_str, :ref:`rcf_pch_cfg_object<doxid-structrcf__pch__cfg__object>`** node);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`rcf_pch_add_node<doxid-group__rcf__pch_1gaf3f0c34fb03ec93f821bc5b4007192bb>`(const char* father, :ref:`rcf_pch_cfg_object<doxid-structrcf__pch__cfg__object>`* node);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`rcf_pch_del_node<doxid-group__rcf__pch_1gacc958fe86dae1b0b847260c832bb02c9>`(:ref:`rcf_pch_cfg_object<doxid-structrcf__pch__cfg__object>`* node);

	// macros

	#define :target:`RCF_PCH_MAX_ID_LEN<doxid-group__rcf__pch_1gaba6dcdf4a7035ae03a68779218cc9762>`

.. _details-group__rcf__pch:

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



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

.. index:: pair: function; rcf_pch_run
.. _doxid-group__rcf__pch_1ga674454c23e4d97f6597fedb057aaf835:

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

	int rcf_pch_run(const char* confstr, const char* info)

Start Portable Command Handler.

Caller is blocked until shutdown command is received or error occur. Custom and default command handlers are called when commands via Test Protocol are received.



.. rubric:: Parameters:

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

	*
		- confstr

		- configuration string for communication library

	*
		- info

		- if not NULL, the string to be send to the engine after initialisation



.. rubric:: Returns:

Status code

.. index:: pair: function; rcf_pch_get_id
.. _doxid-group__rcf__pch_1gaa7ad8c009e665353d909c8257006e950:

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

	void rcf_pch_get_id(char* id)

Get the rcf session identifier.



.. rubric:: Parameters:

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

	*
		- id

		- Location for the id.

.. index:: pair: function; rcf_pch_rpc_init
.. _doxid-group__rcf__pch_1ga9a40137dd5d81703caa11f06c2de0182:

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

	void rcf_pch_rpc_init(const char* tmp_path)

Initialize RCF RPC server structures and link RPC configuration nodes to the root.



.. rubric:: Parameters:

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

	*
		- tmp_path

		- Path to folder where temporary files should be stored

.. index:: pair: function; rpcserver_plugin_enable
.. _doxid-group__rcf__pch_1ga9168424fe0ded5fa118720222654dc25:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` rpcserver_plugin_enable(const char* install, const char* action, const char* uninstall)

Find all callbacks and enable the RPC server plugin.



.. rubric:: Parameters:

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

	*
		- install

		- Function name for install plugin or empty string or ``NULL``

	*
		- action

		- Function name for plugin action or empty string or ``NULL``

	*
		- uninstall

		- Function name for uninstall plugin or empty string or ``NULL``



.. rubric:: Returns:

Status code

.. index:: pair: function; rpcserver_plugin_disable
.. _doxid-group__rcf__pch_1ga67c4da473ca130f94908ac668f623ca5:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` rpcserver_plugin_disable(void)

Disable the RPC server plugin.



.. rubric:: Returns:

Status code

.. index:: pair: function; rcf_pch_find_node
.. _doxid-group__rcf__pch_1ga7119ee0a530695a10651bf2f994be8a3:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` rcf_pch_find_node(const char* oid_str, :ref:`rcf_pch_cfg_object<doxid-structrcf__pch__cfg__object>`** node)

Find a node corresponding to an object with a given OID.



.. rubric:: Parameters:

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

	*
		- oid_str

		- OID string.

	*
		- node

		- Where to save pointer to the node.



.. rubric:: Returns:

Status code.

.. index:: pair: function; rcf_pch_add_node
.. _doxid-group__rcf__pch_1gaf3f0c34fb03ec93f821bc5b4007192bb:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` rcf_pch_add_node(const char* father, :ref:`rcf_pch_cfg_object<doxid-structrcf__pch__cfg__object>`* node)

Add subtree into the configuration tree.



.. rubric:: Parameters:

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

	*
		- father

		- OID of father

	*
		- node

		- node to be inserted



.. rubric:: Returns:

Status code

.. index:: pair: function; rcf_pch_del_node
.. _doxid-group__rcf__pch_1gacc958fe86dae1b0b847260c832bb02c9:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` rcf_pch_del_node(:ref:`rcf_pch_cfg_object<doxid-structrcf__pch__cfg__object>`* node)

Delete subtree into the configuration tree.



.. rubric:: Parameters:

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

	*
		- node

		- node to be deleted



.. rubric:: Returns:

Status code