:orphan: .. index:: pair: group; Command Handler: Traffic Application Domain (TAD) support .. _doxid-group__rcf__ch__tad: Command Handler: Traffic Application Domain (TAD) support ========================================================= .. toctree:: :hidden: enum_rcf_ch_trrecv_flags.rst Overview ~~~~~~~~ A set of functions exported by a Test Agent to support TAD. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // typedefs typedef enum :ref:`rcf_ch_trrecv_flags` :ref:`rcf_ch_trrecv_flags`; // enums enum :ref:`rcf_ch_trrecv_flags`; // global functions :ref:`te_errno` :ref:`rcf_ch_tad_init`(void); :ref:`te_errno` :ref:`rcf_ch_tad_shutdown`(void); int :ref:`rcf_ch_csap_create`(struct rcf_comm_connection* handle, char* cbuf, size_t buflen, size_t answer_plen, const uint8_t* ba, size_t cmdlen, const char* stack, const char* params); int :ref:`rcf_ch_csap_destroy`(struct rcf_comm_connection* handle, char* cbuf, size_t buflen, size_t answer_plen, :ref:`csap_handle_t` csap); int :ref:`rcf_ch_csap_param`(struct rcf_comm_connection* handle, char* cbuf, size_t buflen, size_t answer_plen, :ref:`csap_handle_t` csap, const char* param); int :ref:`rcf_ch_trsend_start`(struct rcf_comm_connection* handle, char* cbuf, size_t buflen, size_t answer_plen, const uint8_t* ba, size_t cmdlen, :ref:`csap_handle_t` csap, bool postponed); int :ref:`rcf_ch_trsend_stop`(struct rcf_comm_connection* handle, char* cbuf, size_t buflen, size_t answer_plen, :ref:`csap_handle_t` csap); int :ref:`rcf_ch_trrecv_start`(struct rcf_comm_connection* handle, char* cbuf, size_t buflen, size_t answer_plen, const uint8_t* ba, size_t cmdlen, :ref:`csap_handle_t` csap, unsigned int num, unsigned int timeout, unsigned int flags); int :ref:`rcf_ch_trrecv_stop`(struct rcf_comm_connection* handle, char* cbuf, size_t buflen, size_t answer_plen, :ref:`csap_handle_t` csap); int :ref:`rcf_ch_trrecv_get`(struct rcf_comm_connection* handle, char* cbuf, size_t buflen, size_t answer_plen, :ref:`csap_handle_t` csap); int :ref:`rcf_ch_trrecv_wait`(struct rcf_comm_connection* handle, char* cbuf, size_t buflen, size_t answer_plen, :ref:`csap_handle_t` csap); int :ref:`rcf_ch_trsend_recv`(struct rcf_comm_connection* handle, char* cbuf, size_t buflen, size_t answer_plen, const uint8_t* ba, size_t cmdlen, :ref:`csap_handle_t` csap, unsigned int timeout, unsigned int flags); int :ref:`rcf_ch_trpoll`(struct rcf_comm_connection* handle, char* cbuf, size_t buflen, size_t answer_plen, :ref:`csap_handle_t` csap, unsigned int timeout); int :ref:`rcf_ch_trpoll_cancel`(struct rcf_comm_connection* handle, char* cbuf, size_t buflen, size_t answer_plen, :ref:`csap_handle_t` csap, unsigned int poll_id); .. _details-group__rcf__ch__tad: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ A set of functions exported by a Test Agent to support TAD. The only supported version of TAD available at ``lib/tad``, so Test Agent code located under ``agents/[agent type]`` should not care about this interface. Typedefs -------- .. index:: pair: typedef; rcf_ch_trrecv_flags .. _doxid-group__rcf__ch__tad_1gac74e6884b34127b599d2cc146e696c16: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef enum :ref:`rcf_ch_trrecv_flags` rcf_ch_trrecv_flags Traffic receive mode flags Global Functions ---------------- .. index:: pair: function; rcf_ch_tad_init .. _doxid-group__rcf__ch__tad_1ga39979218031b32087361fda25149bde5: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` rcf_ch_tad_init(void) Initialize RCF TAD (Traffic Application Domain). .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - TE_ENOSYS - Traffic Application Domain is not supported .. rubric:: Returns: Status code. .. index:: pair: function; rcf_ch_tad_shutdown .. _doxid-group__rcf__ch__tad_1ga1b94e3c24e31bd410037f924164ea82c: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` rcf_ch_tad_shutdown(void) Shutdown RCF TAD (Traffic Application Domain). .. rubric:: Returns: Status code. .. index:: pair: function; rcf_ch_csap_create .. _doxid-group__rcf__ch__tad_1ga3ba910980c30fbf2c9ffff75c075adeb: .. ref-code-block:: cpp :class: doxyrest-title-code-block int rcf_ch_csap_create(struct rcf_comm_connection* handle, char* cbuf, size_t buflen, size_t answer_plen, const uint8_t* ba, size_t cmdlen, const char* stack, const char* params) Create a CSAP (Communication Service Access Point). .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - handle - connection handle * - cbuf - command buffer * - buflen - length of the command buffer * - answer_plen - number of bytes in the command buffer to be copied to the answer * - ba - pointer to location of binary attachment in the command buffer or NULL if no binary attachment is provided * - cmdlen - full length of the command including binary attachment * - stack - protocol stack identifier * - params - parameters passed in the command line or NULL * - 0 - command is supported * - -1 - command is not supported * - other - error returned by communication library .. rubric:: Returns: Indication of command support or error code .. index:: pair: function; rcf_ch_csap_destroy .. _doxid-group__rcf__ch__tad_1ga4a2d36e9637f22bf8fd1c083b6757f59: .. ref-code-block:: cpp :class: doxyrest-title-code-block int rcf_ch_csap_destroy(struct rcf_comm_connection* handle, char* cbuf, size_t buflen, size_t answer_plen, :ref:`csap_handle_t` csap) Delete the CSAP. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - handle - connection handle * - cbuf - command buffer * - buflen - length of the command buffer * - answer_plen - number of bytes in the command buffer to be copied to the answer * - csap - CSAP handle * - 0 - command is supported * - -1 - command is not supported * - other - error returned by communication library .. rubric:: Returns: Indication of command support or error code .. index:: pair: function; rcf_ch_csap_param .. _doxid-group__rcf__ch__tad_1ga38facd3580de9f7f8306e8ee68672df9: .. ref-code-block:: cpp :class: doxyrest-title-code-block int rcf_ch_csap_param(struct rcf_comm_connection* handle, char* cbuf, size_t buflen, size_t answer_plen, :ref:`csap_handle_t` csap, const char* param) Get CSAP parameter .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - handle - connection handle * - cbuf - command buffer * - buflen - length of the command buffer * - answer_plen - number of bytes in the command buffer to be * - csap - CSAP handle * - param - name of the CSAP-specific parameter * - 0 - command is supported * - -1 - command is not supported * - other - error returned by communication library .. rubric:: Returns: Indication of command support or error code .. index:: pair: function; rcf_ch_trsend_start .. _doxid-group__rcf__ch__tad_1ga4c7ed0b3b03dbb62b90d29321b769aa5: .. ref-code-block:: cpp :class: doxyrest-title-code-block int rcf_ch_trsend_start(struct rcf_comm_connection* handle, char* cbuf, size_t buflen, size_t answer_plen, const uint8_t* ba, size_t cmdlen, :ref:`csap_handle_t` csap, bool postponed) "trsend_start" command handler. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - handle - connection handle * - cbuf - command buffer * - buflen - length of the command buffer * - answer_plen - number of bytes in the command buffer to be copied to the answer * - ba - pointer to location of binary attachment in the command buffer or NULL if no binary attachment is provided * - cmdlen - full length of the command including binary attachment * - csap - CSAP handle * - postponed - "postponed" flag value * - 0 - command is supported * - -1 - command is not supported * - other - error returned by communication library .. rubric:: Returns: Indication of command support or error code .. index:: pair: function; rcf_ch_trsend_stop .. _doxid-group__rcf__ch__tad_1ga5f382112d68763a3a4ee6cf38bce7b9d: .. ref-code-block:: cpp :class: doxyrest-title-code-block int rcf_ch_trsend_stop(struct rcf_comm_connection* handle, char* cbuf, size_t buflen, size_t answer_plen, :ref:`csap_handle_t` csap) "trsend_stop" command handler. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - handle - connection handle * - cbuf - command buffer * - buflen - length of the command buffer * - answer_plen - number of bytes in the command buffer to be copied to the answer * - csap - CSAP handle * - 0 - command is supported * - -1 - command is not supported * - other - error returned by communication library .. rubric:: Returns: Indication of command support or error code .. index:: pair: function; rcf_ch_trrecv_start .. _doxid-group__rcf__ch__tad_1gab8ced650f510acb2cde6b6ee8438b89a: .. ref-code-block:: cpp :class: doxyrest-title-code-block int rcf_ch_trrecv_start(struct rcf_comm_connection* handle, char* cbuf, size_t buflen, size_t answer_plen, const uint8_t* ba, size_t cmdlen, :ref:`csap_handle_t` csap, unsigned int num, unsigned int timeout, unsigned int flags) "trrecv_start" command handler. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - handle - connection handle * - cbuf - command buffer * - buflen - length of the command buffer * - answer_plen - number of bytes in the command buffer to be copied to the answer * - ba - pointer to location of binary attachment in the command buffer or NULL if no binary attachment is provided * - cmdlen - full length of the command including binary attachment * - csap - CSAP handle * - num - number of packets to be sent (0 if number of packets is unlimited) * - timeout - maximum duration (in milliseconds) of receiving the traffic * - flags - traffic receive flags (see rcf_ch_trrecv_flags) * - 0 - command is supported * - -1 - command is not supported * - other - error returned by communication library .. rubric:: Returns: Indication of command support or error code .. index:: pair: function; rcf_ch_trrecv_stop .. _doxid-group__rcf__ch__tad_1ga24e463b83ba685da9bd1f7858d106763: .. ref-code-block:: cpp :class: doxyrest-title-code-block int rcf_ch_trrecv_stop(struct rcf_comm_connection* handle, char* cbuf, size_t buflen, size_t answer_plen, :ref:`csap_handle_t` csap) "trrecv_stop" command handler. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - handle - connection handle * - cbuf - command buffer * - buflen - length of the command buffer * - answer_plen - number of bytes in the command buffer to be copied to the answer * - csap - CSAP handle * - 0 - command is supported * - -1 - command is not supported * - other - error returned by communication library .. rubric:: Returns: Indication of command support or error code .. index:: pair: function; rcf_ch_trrecv_get .. _doxid-group__rcf__ch__tad_1ga2f7b1c981485311dcc1801c9cf352019: .. ref-code-block:: cpp :class: doxyrest-title-code-block int rcf_ch_trrecv_get(struct rcf_comm_connection* handle, char* cbuf, size_t buflen, size_t answer_plen, :ref:`csap_handle_t` csap) "trrecv_get" command handler. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - handle - connection handle * - cbuf - command buffer * - buflen - length of the command buffer * - answer_plen - number of bytes in the command buffer to be copied to the answer * - csap - CSAP handle * - 0 - command is supported * - -1 - command is not supported * - other - error returned by communication library .. rubric:: Returns: Indication of command support or error code .. index:: pair: function; rcf_ch_trrecv_wait .. _doxid-group__rcf__ch__tad_1ga6d438062bdd44c92b0eb0bc9ac6b07d4: .. ref-code-block:: cpp :class: doxyrest-title-code-block int rcf_ch_trrecv_wait(struct rcf_comm_connection* handle, char* cbuf, size_t buflen, size_t answer_plen, :ref:`csap_handle_t` csap) "trrecv_wait" command handler. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - handle - connection handle * - cbuf - command buffer * - buflen - length of the command buffer * - answer_plen - number of bytes in the command buffer to be copied to the answer * - csap - CSAP handle * - 0 - command is supported * - -1 - command is not supported * - other - error returned by communication library .. rubric:: Returns: Indication of command support or error code .. index:: pair: function; rcf_ch_trsend_recv .. _doxid-group__rcf__ch__tad_1ga469896224057875346c52d8f05d2ef62: .. ref-code-block:: cpp :class: doxyrest-title-code-block int rcf_ch_trsend_recv(struct rcf_comm_connection* handle, char* cbuf, size_t buflen, size_t answer_plen, const uint8_t* ba, size_t cmdlen, :ref:`csap_handle_t` csap, unsigned int timeout, unsigned int flags) "trsend_recv" command handler. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - handle - connection handle * - cbuf - command buffer * - buflen - length of the command buffer * - answer_plen - number of bytes in the command buffer to be copied to the answer * - ba - pointer to location of binary attachment in the command buffer or NULL if no binary attachment is provided * - cmdlen - full length of the command including binary attachment * - csap - CSAP handle \* * - results - "results" flag value * - timeout - timeout value in milliseconds (if > 0) * - flags - traffic receive flags (see rcf_ch_trrecv_flags) * - 0 - command is supported * - -1 - command is not supported * - other - error returned by communication library .. rubric:: Returns: Indication of command support or error code .. index:: pair: function; rcf_ch_trpoll .. _doxid-group__rcf__ch__tad_1gab5ba1dff61966fe37094df196d66970f: .. ref-code-block:: cpp :class: doxyrest-title-code-block int rcf_ch_trpoll(struct rcf_comm_connection* handle, char* cbuf, size_t buflen, size_t answer_plen, :ref:`csap_handle_t` csap, unsigned int timeout) "trpoll" command handler. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - handle - connection handle * - cbuf - command buffer * - buflen - length of the command buffer * - answer_plen - number of bytes in the command buffer to be copied to the answer * - csap - CSAP handle * - timeout - maximum duration (in milliseconds) of poll * - 0 - command is supported * - -1 - command is not supported * - other - error returned by communication library .. rubric:: Returns: Indication of command support or error code .. index:: pair: function; rcf_ch_trpoll_cancel .. _doxid-group__rcf__ch__tad_1ga00ce0f25e477d536a4e201266ccc6cc7: .. ref-code-block:: cpp :class: doxyrest-title-code-block int rcf_ch_trpoll_cancel(struct rcf_comm_connection* handle, char* cbuf, size_t buflen, size_t answer_plen, :ref:`csap_handle_t` csap, unsigned int poll_id) "trpoll_cancel" command handler. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - handle - connection handle * - cbuf - command buffer * - buflen - length of the command buffer * - answer_plen - number of bytes in the command buffer to be copied to the answer * - csap - CSAP handle * - poll_id - Poll request ID * - 0 - command is supported * - -1 - command is not supported * - other - error returned by communication library .. rubric:: Returns: Indication of command support or error code