:orphan: .. index:: pair: group; TAPI for RTE FLOW API remote calls .. _doxid-group__te__lib__rpc__rte__flow: TAPI for RTE FLOW API remote calls ================================== .. toctree:: :hidden: Overview ~~~~~~~~ .. ref-code-block:: cpp :class: doxyrest-overview-code-block // global functions int :ref:`rpc_rte_flow_validate`(:ref:`rcf_rpc_server`* rpcs, uint16_t port_id, rpc_rte_flow_attr_p attr, rpc_rte_flow_item_p pattern, rpc_rte_flow_action_p actions, :ref:`tarpc_rte_flow_error`* error); rpc_rte_flow_p :ref:`rpc_rte_flow_create`(:ref:`rcf_rpc_server`* rpcs, uint16_t port_id, rpc_rte_flow_attr_p attr, rpc_rte_flow_item_p pattern, rpc_rte_flow_action_p actions, :ref:`tarpc_rte_flow_error`* error); int :ref:`rpc_rte_flow_destroy`(:ref:`rcf_rpc_server`* rpcs, uint16_t port_id, rpc_rte_flow_p flow, :ref:`tarpc_rte_flow_error`* error); int :ref:`rpc_rte_flow_query`(:ref:`rcf_rpc_server`* rpcs, uint16_t port_id, rpc_rte_flow_p flow, rpc_rte_flow_action_p action, tarpc_rte_flow_query_data* data, :ref:`tarpc_rte_flow_error`* error); int :ref:`rpc_rte_flow_flush`(:ref:`rcf_rpc_server`* rpcs, uint16_t port_id, :ref:`tarpc_rte_flow_error`* error); int :ref:`rpc_rte_flow_isolate`(:ref:`rcf_rpc_server`* rpcs, uint16_t port_id, int set, struct :ref:`tarpc_rte_flow_error`* error); int :ref:`rpc_rte_flow_tunnel_decap_set`(:ref:`rcf_rpc_server`* rpcs, uint16_t port_id, const struct :ref:`tarpc_rte_flow_tunnel`* tunnel, rpc_rte_flow_action_p* actions, uint32_t* num_of_actions, struct :ref:`tarpc_rte_flow_error`* error); int :ref:`rpc_rte_flow_tunnel_match`(:ref:`rcf_rpc_server`* rpcs, uint16_t port_id, const struct :ref:`tarpc_rte_flow_tunnel`* tunnel, rpc_rte_flow_item_p* items, uint32_t* num_of_items, struct :ref:`tarpc_rte_flow_error`* error); int :ref:`rpc_rte_flow_get_restore_info`(:ref:`rcf_rpc_server`* rpcs, uint16_t port_id, rpc_rte_mbuf_p m, struct :ref:`tarpc_rte_flow_restore_info`* info, struct :ref:`tarpc_rte_flow_error`* error); int :ref:`rpc_rte_flow_tunnel_action_decap_release`(:ref:`rcf_rpc_server`* rpcs, uint16_t port_id, rpc_rte_flow_action_p actions, uint32_t num_of_actions, struct :ref:`tarpc_rte_flow_error`* error); int :ref:`rpc_rte_flow_tunnel_item_release`(:ref:`rcf_rpc_server`* rpcs, uint16_t port_id, rpc_rte_flow_item_p items, uint32_t num_of_items, struct :ref:`tarpc_rte_flow_error`* error); int :ref:`rpc_rte_flow_pick_transfer_proxy`(:ref:`rcf_rpc_server`* rpcs, uint16_t port_id, uint16_t* proxy_port_id, :ref:`tarpc_rte_flow_error`* error); .. _details-group__te__lib__rpc__rte__flow: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Global Functions ---------------- .. index:: pair: function; rpc_rte_flow_validate .. _doxid-group__te__lib__rpc__rte__flow_1ga3fb4c498e31e95580b4750f1c41d5c45: .. ref-code-block:: cpp :class: doxyrest-title-code-block int rpc_rte_flow_validate(:ref:`rcf_rpc_server`* rpcs, uint16_t port_id, rpc_rte_flow_attr_p attr, rpc_rte_flow_item_p pattern, rpc_rte_flow_action_p actions, :ref:`tarpc_rte_flow_error`* error) rte_flow_validate() RPC. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - port_id - Port number * - attr - RTE flow attr pointer * - pattern - RTE flow item pointer to the array of items * - actions - RTE flow action pointer to the array of actions * - error - Perform verbose error reporting if not ``NULL`` .. rubric:: Returns: ``0`` on success; jumps out in case of failure .. index:: pair: function; rpc_rte_flow_create .. _doxid-group__te__lib__rpc__rte__flow_1gab5db621e230a1b9480fb8afbef281d05: .. ref-code-block:: cpp :class: doxyrest-title-code-block rpc_rte_flow_p rpc_rte_flow_create(:ref:`rcf_rpc_server`* rpcs, uint16_t port_id, rpc_rte_flow_attr_p attr, rpc_rte_flow_item_p pattern, rpc_rte_flow_action_p actions, :ref:`tarpc_rte_flow_error`* error) rte_flow_create() RPC. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - port_id - Port number * - attr - RTE flow attr pointer * - pattern - RTE flow item pointer to the array of items * - actions - RTE flow action pointer to the array of actions * - error - Perform verbose error reporting if not ``NULL`` .. rubric:: Returns: RTE flow pointer on success; jumps out when pointer is ``NULL`` .. index:: pair: function; rpc_rte_flow_destroy .. _doxid-group__te__lib__rpc__rte__flow_1ga0b785cb00e7a9f2d74c5e83a81ad6e8c: .. ref-code-block:: cpp :class: doxyrest-title-code-block int rpc_rte_flow_destroy(:ref:`rcf_rpc_server`* rpcs, uint16_t port_id, rpc_rte_flow_p flow, :ref:`tarpc_rte_flow_error`* error) rte_flow_destroy() RPC. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - port_id - Port number * - flow - RTE flow pointer * - error - Perform verbose error reporting if not ``NULL`` .. rubric:: Returns: ``0`` on success; jumps out in case of failure .. index:: pair: function; rpc_rte_flow_query .. _doxid-group__te__lib__rpc__rte__flow_1ga50f87f8c89072bab36bc763417d1f7c1: .. ref-code-block:: cpp :class: doxyrest-title-code-block int rpc_rte_flow_query(:ref:`rcf_rpc_server`* rpcs, uint16_t port_id, rpc_rte_flow_p flow, rpc_rte_flow_action_p action, tarpc_rte_flow_query_data* data, :ref:`tarpc_rte_flow_error`* error) rte_flow_query() RPC. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - port_id - Port number * - flow - RTE flow pointer * - action - Action definition as defined in original flow rule * - data - Pointer to storage for the associated query data type * - error - Perform verbose error reporting if not ``NULL`` .. rubric:: Returns: ``0`` on success; jumps out in case of failure .. index:: pair: function; rpc_rte_flow_flush .. _doxid-group__te__lib__rpc__rte__flow_1gaf1dd9d72d469c31a76eef28792be8da1: .. ref-code-block:: cpp :class: doxyrest-title-code-block int rpc_rte_flow_flush(:ref:`rcf_rpc_server`* rpcs, uint16_t port_id, :ref:`tarpc_rte_flow_error`* error) rte_flow_flush() RPC. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - rpcs - RPC server handle * - port_id - Port number * - error - Perform verbose error reporting if not NULL .. rubric:: Returns: ``0`` on success; jumps out in case of failure .. index:: pair: function; rpc_rte_flow_isolate .. _doxid-group__te__lib__rpc__rte__flow_1ga8456d3ed0f5b1938aed2a705e4efa32c: .. ref-code-block:: cpp :class: doxyrest-title-code-block int rpc_rte_flow_isolate(:ref:`rcf_rpc_server`* rpcs, uint16_t port_id, int set, struct :ref:`tarpc_rte_flow_error`* error) rte_flow_isolate() RPC .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - port_id - Port number * - set - Non-zero to enter isolated mode, ``0`` to leave it * - error - Perform verbose error reporting if not ``NULL`` .. rubric:: Returns: ``0`` on success; jumps out in case of failure .. index:: pair: function; rpc_rte_flow_tunnel_decap_set .. _doxid-group__te__lib__rpc__rte__flow_1gae740fd99dc21ca9e08f47f4676afb971: .. ref-code-block:: cpp :class: doxyrest-title-code-block int rpc_rte_flow_tunnel_decap_set(:ref:`rcf_rpc_server`* rpcs, uint16_t port_id, const struct :ref:`tarpc_rte_flow_tunnel`* tunnel, rpc_rte_flow_action_p* actions, uint32_t* num_of_actions, struct :ref:`tarpc_rte_flow_error`* error) **rte_flow_tunnel_decap_set()** RPC .. rubric:: Returns: ``0`` on success; jumps out on error (negative value) .. index:: pair: function; rpc_rte_flow_tunnel_match .. _doxid-group__te__lib__rpc__rte__flow_1ga68e218c8824f8571c5f071eba11b62ce: .. ref-code-block:: cpp :class: doxyrest-title-code-block int rpc_rte_flow_tunnel_match(:ref:`rcf_rpc_server`* rpcs, uint16_t port_id, const struct :ref:`tarpc_rte_flow_tunnel`* tunnel, rpc_rte_flow_item_p* items, uint32_t* num_of_items, struct :ref:`tarpc_rte_flow_error`* error) **rte_flow_tunnel_match()** RPC .. rubric:: Returns: ``0`` on success; jumps out on error (negative value) .. index:: pair: function; rpc_rte_flow_get_restore_info .. _doxid-group__te__lib__rpc__rte__flow_1ga19117df6fa1f8ed53d6bad7b9b108261: .. ref-code-block:: cpp :class: doxyrest-title-code-block int rpc_rte_flow_get_restore_info(:ref:`rcf_rpc_server`* rpcs, uint16_t port_id, rpc_rte_mbuf_p m, struct :ref:`tarpc_rte_flow_restore_info`* info, struct :ref:`tarpc_rte_flow_error`* error) **rte_flow_get_restore_info()** RPC .. rubric:: Returns: ``0`` on success .. index:: pair: function; rpc_rte_flow_tunnel_action_decap_release .. _doxid-group__te__lib__rpc__rte__flow_1ga40cb268351e955fad9ec086aae133175: .. ref-code-block:: cpp :class: doxyrest-title-code-block int rpc_rte_flow_tunnel_action_decap_release(:ref:`rcf_rpc_server`* rpcs, uint16_t port_id, rpc_rte_flow_action_p actions, uint32_t num_of_actions, struct :ref:`tarpc_rte_flow_error`* error) **rte_flow_tunnel_action_decap_release()** RPC .. rubric:: Returns: ``0`` on success; jumps out on error (negative value) .. index:: pair: function; rpc_rte_flow_tunnel_item_release .. _doxid-group__te__lib__rpc__rte__flow_1ga558c9984e806ca5a5edda68921a40676: .. ref-code-block:: cpp :class: doxyrest-title-code-block int rpc_rte_flow_tunnel_item_release(:ref:`rcf_rpc_server`* rpcs, uint16_t port_id, rpc_rte_flow_item_p items, uint32_t num_of_items, struct :ref:`tarpc_rte_flow_error`* error) **rte_flow_tunnel_item_release()** RPC .. rubric:: Returns: ``0`` on success; jumps out on error (negative value) .. index:: pair: function; rpc_rte_flow_pick_transfer_proxy .. _doxid-group__te__lib__rpc__rte__flow_1ga40f25d1a9f937a8266f2997732e2e8ad: .. ref-code-block:: cpp :class: doxyrest-title-code-block int rpc_rte_flow_pick_transfer_proxy(:ref:`rcf_rpc_server`* rpcs, uint16_t port_id, uint16_t* proxy_port_id, :ref:`tarpc_rte_flow_error`* error) rte_flow_pick_transfer_proxy() RPC. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - port_id - Port number. * - proxy_port_id - Proxy port id number. * - error - Perform verbose error reporting if not ``NULL``. .. rubric:: Returns: ``0`` on success; jumps out in case of failure.