:orphan: .. index:: pair: group; Forwarder module .. _doxid-group__tapi__tad__forw: Forwarder module ================ .. toctree:: :hidden: Overview ~~~~~~~~ TAPI for Forwarder additional module external declarations. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // global functions int :ref:`tapi_forw_task_create`(const char* ta, int sid, const :ref:`ndn_forw_action_plain`* forw_action, int sendq_id); int :ref:`tapi_forw_sendq_create`(const char* ta, int sid, :ref:`csap_handle_t` csap, int band, int bufsize, int* sendq_id); int :ref:`tapi_forw_sendq_destroy`(const char* ta, int sid, int sendq_id); int :ref:`tapi_forw_task_set_param`(const char* ta, int sid, const char* ftask_name, const char* param, int val); int :ref:`tapi_forw_task_set_drop_rate`(const char* ta, int sid, const char* ftask_name, int rate); int :ref:`tapi_forw_task_set_delay_min`(const char* ta, int sid, const char* ftask_name, int delay); int :ref:`tapi_forw_task_set_reorder_type`(const char* ta, int sid, const char* ftask_name, ndn_forw_reorder_type_t type); int :ref:`tapi_forw_task_set_reorder_to`(const char* ta, int sid, const char* ftask_name, int to); int :ref:`tapi_forw_task_set_reorder_sz`(const char* ta, int sid, const char* ftask_name, int sz); int :ref:`tapi_forw_task_set_delay_max`(const char* ta, int sid, const char* ftask_name, int delay); int :ref:`tapi_forw_task_destroy`(const char* ta, int sid, const char* ftask_name); int :ref:`tapi_forw_sendq_set_param`(const char* ta, int sid, const char* param, int val, int sendq_id); int :ref:`tapi_forw_sendq_get_param`(const char* ta, int sid, const char* param, int sendq_id, int* val); int :ref:`tapi_forw_set_ftask_name`(:ref:`asn_value`* pat_unit, const char* task_name); .. _details-group__tapi__tad__forw: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ TAPI for Forwarder additional module external declarations. Copyright (C) 2004-2022 OKTET Labs Ltd. All rights reserved. Global Functions ---------------- .. index:: pair: function; tapi_forw_task_create .. _doxid-group__tapi__tad__forw_1gad5cdc801b4e0073b4a26fd74bcb4d1f7: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_forw_task_create(const char* ta, int sid, const :ref:`ndn_forw_action_plain`* forw_action, int sendq_id) Create forwarding task according with specification. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - name of TA, on which forw. task should be added * - sid - RCF session ID. * - forw_action - plain C structure with specification of forwarder task * - sendq_id - Id of destination sending queue .. rubric:: Returns: zero on success or error code. .. index:: pair: function; tapi_forw_sendq_create .. _doxid-group__tapi__tad__forw_1ga70d357cb6146581a335f1ae78a7472d5: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_forw_sendq_create(const char* ta, int sid, :ref:`csap_handle_t` csap, int band, int bufsize, int* sendq_id) Create send queue with specified parameters. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - name of TA, on which forw. task should be added * - sid - RCF session ID. * - csap - ID of CSAP, which should send data * - band - Bandwidth of send queue in bytes per second, zero for unlimited * - bufsize - Buffer size of send queue * - sendq_id - location for id of destination sending queue (OUT) .. rubric:: Returns: zero on success or error code. .. index:: pair: function; tapi_forw_sendq_destroy .. _doxid-group__tapi__tad__forw_1gaf1c5fc467bdd0b8066fbb0f34b7421ab: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_forw_sendq_destroy(const char* ta, int sid, int sendq_id) Destroy send queue with specified ID. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - name of TA, on which send queue is running. * - sid - RCF session ID. * - sendq_id - id of sending queue .. rubric:: Returns: zero on success or error code. .. index:: pair: function; tapi_forw_task_set_param .. _doxid-group__tapi__tad__forw_1ga70acc2a9809f1a9573af16db47e26671: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_forw_task_set_param(const char* ta, int sid, const char* ftask_name, const char* param, int val) Set forwarding task parameter. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - name of TA, on which the send queue is situated * - sid - RCF session ID. * - ftask_name - Name of forwarder task. * - param - Parameter name, which should be ASN lib labels string, see ASN lib docs and NDN specification for Forwarder-Action ASN type. * - val - New parameter value. .. rubric:: Returns: zero on success or error code. .. index:: pair: function; tapi_forw_task_set_drop_rate .. _doxid-group__tapi__tad__forw_1ga69bdccce20350e6132ca2e303269705f: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_forw_task_set_drop_rate(const char* ta, int sid, const char* ftask_name, int rate) Set forwarding task drop rate. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - name of TA, on which the send queue is situated * - sid - RCF session ID. * - ftask_name - Name of forwarder task. * - rate - New drop rate value. .. rubric:: Returns: zero on success or error code. .. index:: pair: function; tapi_forw_task_set_delay_min .. _doxid-group__tapi__tad__forw_1gacddddfca07f8d261c85b70bcf96fd1f7: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_forw_task_set_delay_min(const char* ta, int sid, const char* ftask_name, int delay) Set forwarding task minimum delay. Applicable for constant delay type. If delay was disabled, it becomes 'constant' with specified value. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - name of TA, on which the send queue is situated * - sid - RCF session ID * - ftask_name - Name of forwarder task * - delay - New delay value in microseconds .. rubric:: Returns: zero on success or error code. .. index:: pair: function; tapi_forw_task_set_reorder_type .. _doxid-group__tapi__tad__forw_1gaf974f8be4c551c66c5e59c45ac02c67a: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_forw_task_set_reorder_type(const char* ta, int sid, const char* ftask_name, ndn_forw_reorder_type_t type) Set forwarding task reorder type .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - name of TA, on which the send queue is situated * - sid - RCF session ID * - ftask_name - Name of forwarder task * - type - New type value .. rubric:: Returns: zero on success or error code. .. index:: pair: function; tapi_forw_task_set_reorder_to .. _doxid-group__tapi__tad__forw_1ga0adc5bc170683d6ba8da5c8b81932675: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_forw_task_set_reorder_to(const char* ta, int sid, const char* ftask_name, int to) Set forwarding task reorder timeout. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - name of TA, on which the send queue is situated * - sid - RCF session ID * - ftask_name - Name of forwarder task * - to - New timeout value in microseconds .. rubric:: Returns: zero on success or error code. .. index:: pair: function; tapi_forw_task_set_reorder_sz .. _doxid-group__tapi__tad__forw_1ga38c141ac6b87bbf03085b6d1cd0e2f68: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_forw_task_set_reorder_sz(const char* ta, int sid, const char* ftask_name, int sz) Set forwarding task reorder size. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - name of TA, on which the send queue is situated * - sid - RCF session ID * - ftask_name - Name of forwarder task * - sz - New reorder size value .. rubric:: Returns: zero on success or error code. .. index:: pair: function; tapi_forw_task_set_delay_max .. _doxid-group__tapi__tad__forw_1ga61513a3f416d5516134d37a6266ff26e: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_forw_task_set_delay_max(const char* ta, int sid, const char* ftask_name, int delay) Set forwarding task maximum delay. Applicable for constant delay type. If delay was disabled, it becomes 'constant' with specified value. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - name of TA, on which the send queue is situated * - sid - RCF session ID. * - ftask_name - Name of forwarder task. * - delay - New delay value in microseconds. .. rubric:: Returns: zero on success or error code. .. index:: pair: function; tapi_forw_task_destroy .. _doxid-group__tapi__tad__forw_1gac7c36dbd8f623664c00a093084371d65: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_forw_task_destroy(const char* ta, int sid, const char* ftask_name) Destroy forwarding task. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - name of TA, on which the send queue is situated * - sid - RCF session ID. * - ftask_name - Name of forwarder task. .. rubric:: Returns: zero on success or error code. .. index:: pair: function; tapi_forw_sendq_set_param .. _doxid-group__tapi__tad__forw_1ga853933ce1782f30ce1beef8beecd3fae: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_forw_sendq_set_param(const char* ta, int sid, const char* param, int val, int sendq_id) Set send queue parameters. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - name of TA, on which the send queue is situated * - sid - RCF session ID. * - param - Parameter name in human form ("size_max" or "bandwidth") * - val - New parameter value. * - sendq_id - ID of the send queue. .. rubric:: Returns: zero on success or error code. .. index:: pair: function; tapi_forw_sendq_get_param .. _doxid-group__tapi__tad__forw_1ga369b0caf61f89a55f2a1bdbe2d0dce09: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_forw_sendq_get_param(const char* ta, int sid, const char* param, int sendq_id, int* val) Get send queue parameters. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - name of TA, on which the send queue is situated * - sid - RCF session ID. * - param - Parameter name in human form ("size_max" or "bandwidth") * - sendq_id - ID of the send queue. * - val - Value of the parameter (OUT) .. rubric:: Returns: zero on success or error code. .. index:: pair: function; tapi_forw_set_ftask_name .. _doxid-group__tapi__tad__forw_1gacda65a6fc64565c45de749c78ca5e8b4: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_forw_set_ftask_name(:ref:`asn_value`* pat_unit, const char* task_name) Set forw task name to pattern unit .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - pat_unit - ASN value of type Traffic-Pattern-Unit * - task_name - Name of forwarder task. .. rubric:: Returns: zero on success or error code.