:orphan: .. index:: pair: group; Socket .. _doxid-group__tapi__tad__socket: Socket ====== .. toctree:: :hidden: Overview ~~~~~~~~ Declarations of TAPI methods for raw-TCP CSAP. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // global functions :ref:`te_errno` :ref:`tapi_tcp_server_csap_create`(const char* ta_name, int sid, const struct sockaddr* sa, :ref:`csap_handle_t`* tcp_csap); :ref:`te_errno` :ref:`tapi_tcp_client_csap_create`(const char* ta_name, int sid, const struct sockaddr* loc, const struct sockaddr* rem, :ref:`csap_handle_t`* tcp_csap); :ref:`te_errno` :ref:`tapi_tcp_socket_csap_create`(const char* ta_name, int sid, int socket, :ref:`csap_handle_t`* tcp_csap); :ref:`te_errno` :ref:`tapi_tcp_server_recv`(const char* ta_name, int sid, :ref:`csap_handle_t` tcp_csap, unsigned int timeout, int* socket); :ref:`te_errno` :ref:`tapi_socket_recv`(const char* ta_name, int sid, :ref:`csap_handle_t` csap, unsigned int timeout, :ref:`csap_handle_t` forward, bool exact, uint8_t* buf, size_t* length); :ref:`te_errno` :ref:`tapi_socket_send`(const char* ta_name, int sid, :ref:`csap_handle_t` csap, uint8_t* buf, size_t length); :ref:`te_errno` :ref:`tapi_socket_csap_create`(const char* ta_name, int sid, int type, const struct sockaddr* loc, const struct sockaddr* rem, :ref:`csap_handle_t`* csap); :ref:`te_errno` :ref:`tapi_udp_csap_create`(const char* ta_name, int sid, const struct sockaddr* loc, const struct sockaddr* rem, :ref:`csap_handle_t`* udp_csap); .. _details-group__tapi__tad__socket: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Declarations of TAPI methods for raw-TCP CSAP. Copyright (C) 2004-2022 OKTET Labs Ltd. All rights reserved. Global Functions ---------------- .. index:: pair: function; tapi_tcp_server_csap_create .. _doxid-group__tapi__tad__socket_1ga3b3980b3eab9dbefa111f1fb68a45140: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_tcp_server_csap_create(const char* ta_name, int sid, const struct sockaddr* sa, :ref:`csap_handle_t`* tcp_csap) Creates 'data.tcp.ip4' CSAP, 'server' mode: listening for incoming connections. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name * - sid - RCF SID * - sa - Local address and port * - tcp_csap - Location for the IPv4 CSAP handle (OUT) .. rubric:: Returns: Status of the operation .. index:: pair: function; tapi_tcp_client_csap_create .. _doxid-group__tapi__tad__socket_1gaad9670f38b90a15c479378c1f7fe157b: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_tcp_client_csap_create(const char* ta_name, int sid, const struct sockaddr* loc, const struct sockaddr* rem, :ref:`csap_handle_t`* tcp_csap) Creates 'socket' CSAP, 'TCP client' mode. Connects to remote TCP server. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name * - sid - RCF SID * - loc - Local address and port * - rem - Remote address and port * - tcp_csap - Location for the IPv4 CSAP handle (OUT) .. rubric:: Returns: Status of the operation .. index:: pair: function; tapi_tcp_socket_csap_create .. _doxid-group__tapi__tad__socket_1ga5ad8d70af6c2831d118e632f9fa19c24: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_tcp_socket_csap_create(const char* ta_name, int sid, int socket, :ref:`csap_handle_t`* tcp_csap) Creates 'data.tcp.ip4' CSAP, 'socket' mode, over socket, accepted on TA from some 'server' CSAP. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name * - sid - RCF SID * - socket - socket fd on TA * - tcp_csap - Location for the TCP CSAP handle (OUT) .. rubric:: Returns: Status of the operation .. index:: pair: function; tapi_tcp_server_recv .. _doxid-group__tapi__tad__socket_1gaf744c1db162a7767778c32d83a49d04b: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_tcp_server_recv(const char* ta_name, int sid, :ref:`csap_handle_t` tcp_csap, unsigned int timeout, int* socket) Wait new one connection from 'server' TCP CSAP. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name * - sid - RCF SID * - tcp_csap - TCP CSAP handle * - timeout - timeout in milliseconds * - socket - location for accepted socket fd on TA (OUT) .. rubric:: Returns: Status of the operation .. index:: pair: function; tapi_socket_recv .. _doxid-group__tapi__tad__socket_1gabe6c8ffe5edb7f1bcb9a50eaa35b24ff: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_socket_recv(const char* ta_name, int sid, :ref:`csap_handle_t` csap, unsigned int timeout, :ref:`csap_handle_t` forward, bool exact, uint8_t* buf, size_t* length) Wait some data on connected (i.e. non-server) 'socket' CSAP. CSAP can wait for any non-zero amount of bytes or for exactly specified number; use 'exact' argument to manage it. For UDP socket parameter 'exact' is ignored, since UDP socket receives data by datagrams. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name * - sid - RCF SID * - tcp_csap - CSAP handle * - timeout - timeout in milliseconds * - forward - id of CSAP to which forward received messages, may be CSAP_INVALID_HANDLE for disabled forward * - exact - boolean flag: whether CSAP have to wait all specified number of bytes or not * - buf - location for received data, may be NULL if received data is not wanted on test (OUT) * - length - location with/for buffer/data length (IN/OUT) .. rubric:: Returns: Status of the operation .. index:: pair: function; tapi_socket_send .. _doxid-group__tapi__tad__socket_1ga8176757ce2103e489912caf26572f634: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_socket_send(const char* ta_name, int sid, :ref:`csap_handle_t` csap, uint8_t* buf, size_t length) Send data via connected (non-server) 'socket' CSAP. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name * - sid - RCF SID * - tcp_csap - CSAP handle * - buf - pointer to the data to be send * - length - length of data .. rubric:: Returns: Status of the operation .. index:: pair: function; tapi_socket_csap_create .. _doxid-group__tapi__tad__socket_1ga2c42e19f694b408f24efb3cfad0794b3: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_socket_csap_create(const char* ta_name, int sid, int type, const struct sockaddr* loc, const struct sockaddr* rem, :ref:`csap_handle_t`* csap) Creates usual 'socket' CSAP of some network type. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name * - sid - RCF SID * - type - String, type of socket: should be either ``NDN_TAG_SOCKET_TYPE_UDP`` or ``NDN_TAG_SOCKET_TYPE_TCP_CLIENT``. * - loc - Local address and port * - rem - Remote address and port * - csap - Identifier of an SNMP CSAP (OUT) .. rubric:: Returns: Zero on success or error code. .. index:: pair: function; tapi_udp_csap_create .. _doxid-group__tapi__tad__socket_1gaccb0080ff73f691774aed61f68a96669: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_udp_csap_create(const char* ta_name, int sid, const struct sockaddr* loc, const struct sockaddr* rem, :ref:`csap_handle_t`* udp_csap) Creates usual 'socket' CSAP of UDP type on specified Test Agent .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name * - sid - RCF SID * - loc - Local address and port * - rem - Remote address and port * - udp_csap - Identifier of an SNMP CSAP (OUT) .. rubric:: Returns: Zero on success or error code.