:orphan:

.. index:: pair: group; Command monitor TAPI
.. _doxid-group__tapi__cmd__monitor__def:

Command monitor TAPI
====================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Definition of API to configure command monitor. :ref:`More...<details-group__tapi__cmd__monitor__def>`


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

	
	// global functions

	static :ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_cmd_monitor_begin<doxid-group__tapi__cmd__monitor__def_1ga25aa4eb9ae6070d7908aef0fc2d6114f>`(char const* ta, char const* name, char const* command, int time_to_wait);
	static :ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_cmd_monitor_end<doxid-group__tapi__cmd__monitor__def_1gad56f38325f9d890ba207fab2784ac875>`(char const* ta, char const* name);

.. _details-group__tapi__cmd__monitor__def:

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

Definition of API to configure command monitor.

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

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

.. index:: pair: function; tapi_cfg_cmd_monitor_begin
.. _doxid-group__tapi__cmd__monitor__def_1ga25aa4eb9ae6070d7908aef0fc2d6114f:

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

	static :ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_cmd_monitor_begin(char const* ta, char const* name, char const* command, int time_to_wait)

Start a command monitor. It will periodically run specified shell command and log its output.



.. rubric:: Parameters:

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

	*
		- ta

		- Test Agent name.

	*
		- name

		- Name for a node in configuration tree.

	*
		- command

		- Command to run.

	*
		- time_to_wait

		- How long to wait before running a command again, in milliseconds.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_cfg_cmd_monitor_end
.. _doxid-group__tapi__cmd__monitor__def_1gad56f38325f9d890ba207fab2784ac875:

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

	static :ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_cmd_monitor_end(char const* ta, char const* name)

Stop a command monitor (removing its node from configuration tree).



.. rubric:: Parameters:

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

	*
		- ta

		- Test Agent name.

	*
		- name

		- Name of the command monitor node in configuration tree.



.. rubric:: Returns:

Status code.