:orphan:

.. index:: pair: struct; rcf_msg
.. _doxid-structrcf__msg:

struct rcf_msg
==============

.. toctree::
	:hidden:

Overview
~~~~~~~~

Definition of the RCF internal protocol message format :ref:`More...<details-structrcf__msg>`


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

	#include <rcf_internal.h>
	
	struct rcf_msg {
		// fields
	
		:ref:`rcf_op_t<doxid-rcf__internal_8h_1ad391371ee9b7f40edae7b6f44e45be1b>` :ref:`opcode<doxid-structrcf__msg_1ab174834e67a34242081d3c9de579011d>`;
		uint32_t :ref:`seqno<doxid-structrcf__msg_1afc77f78a86c80229b67f4106be552a91>`;
		int :ref:`flags<doxid-structrcf__msg_1af674875c8e3c58085d77c47975d7eb5d>`;
		int :ref:`sid<doxid-structrcf__msg_1aa6806b4c5a6b98c04a6d55a23af59b05>`;
		:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`error<doxid-structrcf__msg_1aebc0d16257696df9467c5f8ce4e03846>`;
		char :ref:`ta<doxid-structrcf__msg_1a20d2817a90894d105a259c7f65c82b38>`[RCF_MAX_NAME];
		int :ref:`handle<doxid-structrcf__msg_1a09c77a628a2092cd9807058d4c28d094>`;
		int :ref:`num<doxid-structrcf__msg_1a70e9799e5834b5c784ef6636d80bccd0>`;
		uint32_t :ref:`timeout<doxid-structrcf__msg_1ac3b6ab413fd7f5a42433e534d01466d7>`;
		int :ref:`intparm<doxid-structrcf__msg_1adcfe3427b0e38c40c8d395e84019c5b4>`;
		size_t :ref:`data_len<doxid-structrcf__msg_1a6bfe148f0b4d58b0becc4889919bd6bd>`;
		char :ref:`id<doxid-structrcf__msg_1adcd5a268b4e2b0c326d62e7df4310cda>`[RCF_MAX_ID];
		char :ref:`file<doxid-structrcf__msg_1a92f011c4d5de9617f1a5fa1ddff9be42>`[RCF_MAX_PATH];
		char :ref:`value<doxid-structrcf__msg_1a4b4629eb3b067c6ea7e48e08043b144e>`[RCF_MAX_VAL];
		char :ref:`data<doxid-structrcf__msg_1a711b847247d98fc009bba388ff7ed90c>`[0];
	};
.. _details-structrcf__msg:

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

Definition of the RCF internal protocol message format

Fields
------

.. index:: pair: variable; opcode
.. _doxid-structrcf__msg_1ab174834e67a34242081d3c9de579011d:

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

	:ref:`rcf_op_t<doxid-rcf__internal_8h_1ad391371ee9b7f40edae7b6f44e45be1b>` opcode

Operation code - see above

.. index:: pair: variable; seqno
.. _doxid-structrcf__msg_1afc77f78a86c80229b67f4106be552a91:

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

	uint32_t seqno

Sequence number

.. index:: pair: variable; flags
.. _doxid-structrcf__msg_1af674875c8e3c58085d77c47975d7eb5d:

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

	int flags

Auxiliary flag

.. index:: pair: variable; sid
.. _doxid-structrcf__msg_1aa6806b4c5a6b98c04a6d55a23af59b05:

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

	int sid

Session identifier

.. index:: pair: variable; error
.. _doxid-structrcf__msg_1aebc0d16257696df9467c5f8ce4e03846:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` error

Error code (in the answer)

.. index:: pair: variable; ta
.. _doxid-structrcf__msg_1a20d2817a90894d105a259c7f65c82b38:

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

	char ta[RCF_MAX_NAME]

Test Agent name

.. index:: pair: variable; handle
.. _doxid-structrcf__msg_1a09c77a628a2092cd9807058d4c28d094:

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

	int handle

CSAP handle or PID

.. index:: pair: variable; num
.. _doxid-structrcf__msg_1a70e9799e5834b5c784ef6636d80bccd0:

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

	int num

Number of sent/received packets or process priority

.. index:: pair: variable; timeout
.. _doxid-structrcf__msg_1ac3b6ab413fd7f5a42433e534d01466d7:

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

	uint32_t timeout

Timeout value (RCFOP_TRSEND_RECV, RCFOP_TRRECV_START, RCFOP_TRPOLL, RCFOP_RPC)

.. index:: pair: variable; intparm
.. _doxid-structrcf__msg_1adcfe3427b0e38c40c8d395e84019c5b4:

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

	int intparm

Integer parameter: variable type; routine arguments passing mode; execute mode; postponed and results flags (tr\_\* commands); routine return code (RCFOP_EXECUTE); encode data length (RCFOP_RPC); answer error (RCFOP_TRSEND_RECV); poll request ID (RCFOP_TRPOLL, RCFOP_TRPOLL_CANCEL)

.. index:: pair: variable; data_len
.. _doxid-structrcf__msg_1a6bfe148f0b4d58b0becc4889919bd6bd:

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

	size_t data_len

Length of additional data

.. index:: pair: variable; id
.. _doxid-structrcf__msg_1adcd5a268b4e2b0c326d62e7df4310cda:

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

	char id[RCF_MAX_ID]

TA type; variable name; routine name; object identifier; stack identifier; RPC server name

.. index:: pair: variable; file
.. _doxid-structrcf__msg_1a92f011c4d5de9617f1a5fa1ddff9be42:

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

	char file[RCF_MAX_PATH]

Local full file name

.. index:: pair: variable; value
.. _doxid-structrcf__msg_1a4b4629eb3b067c6ea7e48e08043b144e:

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

	char value[RCF_MAX_VAL]

Value of the variable or object instance

.. index:: pair: variable; data
.. _doxid-structrcf__msg_1a711b847247d98fc009bba388ff7ed90c:

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

	char data[0]

Start of additional for commands: RCFOP_TALIST (list of names); RCFOP_TAREBOOT (parameters); RCFOP_CSAP_CREATE (parameters); RCFOP_EXECUTE (parameters); RCFOP_RPC (encoded data); RCFOP_GET/PUT (remote file)