:orphan:

.. index:: pair: struct; cli_csap_specific_data
.. _doxid-structcli__csap__specific__data:

struct cli_csap_specific_data
=============================

.. toctree::
	:hidden:

Overview
~~~~~~~~




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

	
	struct cli_csap_specific_data {
		// fields
	
		int :ref:`io<doxid-structcli__csap__specific__data_1a96728cdc810c3e0a1cbaf08366c2bc41>`;
		FILE* :ref:`fp<doxid-structcli__csap__specific__data_1a6a33390959ae654d56561c3e17a2cc72>`;
		pid_t :ref:`expect_pid<doxid-structcli__csap__specific__data_1aef3729b3c5d317404918e882c443913e>`;
		pid_t :ref:`session_pid<doxid-structcli__csap__specific__data_1a5587e3043ba8c0797077c2f7cfafb9b0>`;
		bool :ref:`kernel_like_2_4<doxid-structcli__csap__specific__data_1a6926a0f7efda9e5cfb95a12a2d72e3ff>`;
		int :ref:`data_sock<doxid-structcli__csap__specific__data_1acc0b2e8696158b984c5485827ea5d41e>`;
		int :ref:`sync_pipe<doxid-structcli__csap__specific__data_1a262924f183bfede45da250df4e3673e5>`;
		size_t :ref:`last_cmd_len<doxid-structcli__csap__specific__data_1a7dcf13a5004fcee15607e316cc8272ea>`;
		cli_conn_type_t :ref:`conn_type<doxid-structcli__csap__specific__data_1a2dc482383b7359358f1bc826e2588cc9>`;
		char* :ref:`program<doxid-structcli__csap__specific__data_1ae5a19c922c5254c5c2f5f3fdd847191e>`;
		char* :ref:`device<doxid-structcli__csap__specific__data_1a3df7f5267b0a4b8d46d68309722334f0>`;
		char* :ref:`host<doxid-structcli__csap__specific__data_1a292b9637e9c2b93842fc0a6fbe6bc824>`;
		unsigned short :ref:`port<doxid-structcli__csap__specific__data_1a5e7ad5f6bc84d03969dd9bac04b37f64>`;
		char* :ref:`shell_args<doxid-structcli__csap__specific__data_1a13e2e61c780d80c78acaf2eef9f504c0>`;
		char* :ref:`user<doxid-structcli__csap__specific__data_1a1581bb9df06a18d505232b26efba87a9>`;
		char* :ref:`password<doxid-structcli__csap__specific__data_1abfa26577a274d623d29672e24f193eaf>`;
		uint32_t :ref:`status<doxid-structcli__csap__specific__data_1a217ce292a4740f2cd030b2d801162b31>`;
		:ref:`cli_csap_prompts_t<doxid-tad__cli__impl_8h_1ae2659bb6509dc9c37f718a40015462a3>` :ref:`init_prompts<doxid-structcli__csap__specific__data_1a00b3ca2f7b88f3e4ecaeb093cd785674>`;
		:ref:`cli_csap_prompts_t<doxid-tad__cli__impl_8h_1ae2659bb6509dc9c37f718a40015462a3>` :ref:`cur_prompts<doxid-structcli__csap__specific__data_1a980eb8bda145451122932578256c8987>`;
		struct exp_case :ref:`prompts<doxid-structcli__csap__specific__data_1af320a721f591bb4cdfcd493f85c5e055>`[CLI_MAX_PROMPTS];
		int :ref:`read_timeout<doxid-structcli__csap__specific__data_1acf1c5145c0a6c96cb7f4d6b4ffb2a492>`;
	};
.. _details-structcli__csap__specific__data:

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



Fields
------

.. index:: pair: variable; io
.. _doxid-structcli__csap__specific__data_1a96728cdc810c3e0a1cbaf08366c2bc41:

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

	int io

file descriptor of CLI session stdin and stdout

.. index:: pair: variable; fp
.. _doxid-structcli__csap__specific__data_1a6a33390959ae654d56561c3e17a2cc72:

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

	FILE* fp

file descriptor of CLI session stdin and stdout

.. index:: pair: variable; expect_pid
.. _doxid-structcli__csap__specific__data_1aef3729b3c5d317404918e882c443913e:

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

	pid_t expect_pid

Expect process ID

.. index:: pair: variable; session_pid
.. _doxid-structcli__csap__specific__data_1a5587e3043ba8c0797077c2f7cfafb9b0:

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

	pid_t session_pid

CLI session process ID

.. index:: pair: variable; kernel_like_2_4
.. _doxid-structcli__csap__specific__data_1a6926a0f7efda9e5cfb95a12a2d72e3ff:

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

	bool kernel_like_2_4

Wheter we are working with 2.4 kernel or not

.. index:: pair: variable; data_sock
.. _doxid-structcli__csap__specific__data_1acc0b2e8696158b984c5485827ea5d41e:

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

	int data_sock

Endpoint for communication with peer:

* on CSAP Engine: Used for sending commands and for reading command results,

* on Expect side: For reading commands and for sending command results

.. index:: pair: variable; sync_pipe
.. _doxid-structcli__csap__specific__data_1a262924f183bfede45da250df4e3673e5:

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

	int sync_pipe

Used for sync mesages sent from Expect side to CSAP Engine.

.. index:: pair: variable; last_cmd_len
.. _doxid-structcli__csap__specific__data_1a7dcf13a5004fcee15607e316cc8272ea:

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

	size_t last_cmd_len

The length of the last command run

.. index:: pair: variable; conn_type
.. _doxid-structcli__csap__specific__data_1a2dc482383b7359358f1bc826e2588cc9:

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

	cli_conn_type_t conn_type

CLI protocol type

.. index:: pair: variable; program
.. _doxid-structcli__csap__specific__data_1ae5a19c922c5254c5c2f5f3fdd847191e:

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

	char* program

Default program to start (millicom, telnet, ssh or sh)

.. index:: pair: variable; device
.. _doxid-structcli__csap__specific__data_1a3df7f5267b0a4b8d46d68309722334f0:

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

	char* device

Default device (NULL if not defined)

.. index:: pair: variable; host
.. _doxid-structcli__csap__specific__data_1a292b9637e9c2b93842fc0a6fbe6bc824:

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

	char* host

Default remote host (NULL if not defined)

.. index:: pair: variable; port
.. _doxid-structcli__csap__specific__data_1a5e7ad5f6bc84d03969dd9bac04b37f64:

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

	unsigned short port

remote host port

.. index:: pair: variable; shell_args
.. _doxid-structcli__csap__specific__data_1a13e2e61c780d80c78acaf2eef9f504c0:

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

	char* shell_args

Shell CLI session arguments (NULL if not defined)

.. index:: pair: variable; user
.. _doxid-structcli__csap__specific__data_1a1581bb9df06a18d505232b26efba87a9:

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

	char* user

Default user account (NULL if not defined)

.. index:: pair: variable; password
.. _doxid-structcli__csap__specific__data_1abfa26577a274d623d29672e24f193eaf:

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

	char* password

Default user password (NULL if not defined)

.. index:: pair: variable; status
.. _doxid-structcli__csap__specific__data_1a217ce292a4740f2cd030b2d801162b31:

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

	uint32_t status

Status bits of the CSAP

.. index:: pair: variable; init_prompts
.. _doxid-structcli__csap__specific__data_1a00b3ca2f7b88f3e4ecaeb093cd785674:

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

	:ref:`cli_csap_prompts_t<doxid-tad__cli__impl_8h_1ae2659bb6509dc9c37f718a40015462a3>` init_prompts

A set of prompts found on init. These values are used for any 'send' operation that does not have prompt information in its PDU.

.. index:: pair: variable; cur_prompts
.. _doxid-structcli__csap__specific__data_1a980eb8bda145451122932578256c8987:

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

	:ref:`cli_csap_prompts_t<doxid-tad__cli__impl_8h_1ae2659bb6509dc9c37f718a40015462a3>` cur_prompts

A set of prompts to be used in current waiting for response action. The value is copied from ``init_prompts`` and then particular prompts are overwritten with values kept in packet PDU (if specified).

.. index:: pair: variable; prompts
.. _doxid-structcli__csap__specific__data_1af320a721f591bb4cdfcd493f85c5e055:

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

	struct exp_case prompts[CLI_MAX_PROMPTS]

An array of prompts passed to Expect library. This value is a converted form of ``cur_prompts`` field suitable for Expect library.

.. index:: pair: variable; read_timeout
.. _doxid-structcli__csap__specific__data_1acf1c5145c0a6c96cb7f4d6b4ffb2a492:

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

	int read_timeout

Number of second to wait for data