:orphan: .. index:: pair: group; Network environment .. _doxid-group__tapi__env: Network environment =================== .. toctree:: :hidden: enum_tapi_env_addr_type.rst enum_tapi_env_type.rst struct_cfg_handle_tqe.rst struct_tapi_env.rst struct_tapi_env_addr.rst struct_tapi_env_alias.rst struct_tapi_env_host.rst struct_tapi_env_if.rst struct_tapi_env_net.rst struct_tapi_env_pco.rst struct_tapi_env_process.rst struct_tapi_env_ps_if.rst Overview ~~~~~~~~ Optional library which can help to simplify test iteration and description of the tested network environment schema. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // typedefs typedef struct :ref:`cfg_handle_tqe` :ref:`cfg_handle_tqe`; typedef struct :ref:`tapi_env_net` :ref:`tapi_env_net`; typedef struct :ref:`tapi_env_host` :ref:`tapi_env_host`; typedef struct :ref:`tapi_env_if` :ref:`tapi_env_if`; typedef struct :ref:`tapi_env_ps_if` :ref:`tapi_env_ps_if`; typedef struct :ref:`tapi_env_process` :ref:`tapi_env_process`; typedef struct :ref:`tapi_env_pco` :ref:`tapi_env_pco`; typedef struct :ref:`tapi_env_addr` :ref:`tapi_env_addr`; typedef struct :ref:`tapi_env_alias` :ref:`tapi_env_alias`; typedef struct :ref:`tapi_env` :ref:`tapi_env`; typedef void :target:`tapi_env_foreach_if_fn`( tapi_env_if *iface, void *opaque ); // enums enum :ref:`tapi_env_addr_type`; enum :ref:`tapi_env_type`; // structs struct :ref:`cfg_handle_tqe`; struct :ref:`tapi_env`; struct :ref:`tapi_env_addr`; struct :ref:`tapi_env_alias`; struct :ref:`tapi_env_host`; struct :ref:`tapi_env_if`; struct :ref:`tapi_env_net`; struct :ref:`tapi_env_pco`; struct :ref:`tapi_env_process`; struct :ref:`tapi_env_ps_if`; // global functions static const char* :target:`tapi_env_type_str`(:ref:`tapi_env_type` type); typedef :ref:`STAILQ_HEAD`(cfg_handle_tqh, :ref:`cfg_handle_tqe`); typedef :ref:`SLIST_HEAD`(tapi_env_nets, :ref:`tapi_env_net`); typedef :ref:`SLIST_HEAD`(tapi_env_processes, :ref:`tapi_env_process`); typedef :ref:`SLIST_HEAD`(tapi_env_hosts, :ref:`tapi_env_host`); typedef :ref:`CIRCLEQ_HEAD`(tapi_env_ifs, :ref:`tapi_env_if`); typedef :ref:`STAILQ_HEAD`(tapi_env_ps_ifs, :ref:`tapi_env_ps_if`); typedef :ref:`STAILQ_HEAD`(tapi_env_pcos, :ref:`tapi_env_pco`); typedef :ref:`CIRCLEQ_HEAD`(tapi_env_addrs, :ref:`tapi_env_addr`); typedef :ref:`SLIST_HEAD`(tapi_env_aliases, :ref:`tapi_env_alias`); :ref:`te_errno` :ref:`tapi_env_init`(:ref:`tapi_env`* env); :ref:`te_errno` :ref:`tapi_env_get`(const char* cfg, :ref:`tapi_env`* env); :ref:`te_errno` :ref:`tapi_env_get_rpcs_only`(const char* cfg, :ref:`tapi_env`* env); :ref:`te_errno` :ref:`tapi_env_allocate_addr`(:ref:`tapi_env_net`* net, int af, struct sockaddr** addr, socklen_t* addrlen); :ref:`te_errno` :ref:`tapi_env_free`(:ref:`tapi_env`* env); :ref:`tapi_env_net`* :ref:`tapi_env_get_net`(:ref:`tapi_env`* env, const char* name); :ref:`tapi_env_host`* :ref:`tapi_env_get_host`(:ref:`tapi_env`* env, const char* name); :ref:`rcf_rpc_server`* :ref:`tapi_env_get_pco`(:ref:`tapi_env`* env, const char* name); const struct sockaddr* :ref:`tapi_env_get_addr`(:ref:`tapi_env`* env, const char* name, socklen_t* addrlen); :ref:`tapi_env_addr_type` :ref:`tapi_get_addr_type`(:ref:`tapi_env`* env, const char* name); const struct if_nameindex* :ref:`tapi_env_get_if`(:ref:`tapi_env`* env, const char* name); const :ref:`tapi_env_if`* :ref:`tapi_env_get_env_if`(:ref:`tapi_env`* env, const char* name); const struct if_nameindex* :ref:`tapi_env_get_br`(:ref:`tapi_env`* env, const char* name); const struct if_nameindex* :ref:`tapi_env_get_ph`(:ref:`tapi_env`* env, const char* name); :ref:`te_errno` :ref:`tapi_env_get_net_host_addr`(const :ref:`tapi_env`* env, const :ref:`tapi_env_net`* net, const :ref:`tapi_env_host`* host, sa_family_t af, :ref:`tapi_cfg_net_assigned`* assigned, struct sockaddr** addr, socklen_t* addrlen); const :ref:`tapi_env_pco`* :ref:`tapi_env_rpcs2pco`(const :ref:`tapi_env`* env, const :ref:`rcf_rpc_server`* rpcs); struct sockaddr** :ref:`tapi_env_add_addresses`(:ref:`rcf_rpc_server`* rpcs, :ref:`tapi_env_net`* net, int af, const struct if_nameindex* iface, int addr_num); void :ref:`tapi_env_foreach_if`(:ref:`tapi_env`* env, tapi_env_foreach_if_fn* fn, void* opaque); unsigned :ref:`tapi_env_nets_count`(:ref:`tapi_env`* env); const :ref:`cfg_net_node_t`* :ref:`tapi_env_get_if_net_node`(const :ref:`tapi_env_if`* iface); // macros #define :ref:`CHECK_ADDR_FAKE`(addr_, fake_) #define :ref:`TEST_END_ENV` #define :ref:`TEST_GET_ADDR`(pco_, addr_) #define :ref:`TEST_GET_ADDR_NO_PORT`(addr_) #define :ref:`TEST_GET_ADDR_REUSE_PORT`(pco_, src_, addr_) #define :ref:`TEST_GET_BR`(if_, br_) #define :ref:`TEST_GET_ENV_IF`(env_if_) #define :ref:`TEST_GET_HOST`(host_) #define :ref:`TEST_GET_IF`(if_) #define :ref:`TEST_GET_LINK_ADDR`(addr_) #define :ref:`TEST_GET_NET`(net_) #define :ref:`TEST_GET_PCO`(rpcs_) #define :ref:`TEST_GET_PH`(if_, ph_) #define :ref:`TEST_START_ENV` #define :ref:`TEST_START_ENV_VARS` .. _details-group__tapi__env: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Optional library which can help to simplify test iteration and description of the tested network environment schema. If the library is used then every test in the test suite has to have argument **env** written in YACC which describes location of IUT and Tester RPC servers, nets, interfaces and addresses. Copyright (C) 2004-2022 OKTET Labs Ltd. All rights reserved. Typedefs -------- .. index:: pair: typedef; cfg_handle_tqe .. _doxid-group__tapi__env_1ga2cda73a43e0dc01b6b417a36d588c108: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`cfg_handle_tqe` cfg_handle_tqe Tail queue of Cfgr handles .. index:: pair: typedef; tapi_env_net .. _doxid-group__tapi__env_1gaf18139a7598e590242ea2ef256b722c1: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_env_net` tapi_env_net Network entry .. index:: pair: typedef; tapi_env_host .. _doxid-group__tapi__env_1gabf1498eb56bfcb609f3f13bb152f2a92: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_env_host` tapi_env_host Host entry in environment .. index:: pair: typedef; tapi_env_if .. _doxid-group__tapi__env_1ga3929c8d366f4ee2b08b4e3527a2c2bc4: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_env_if` tapi_env_if Host/interface entry in environment .. index:: pair: typedef; tapi_env_ps_if .. _doxid-group__tapi__env_1ga7656b57049633c1d24160e634a43d06e: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_env_ps_if` tapi_env_ps_if Process interfaces .. index:: pair: typedef; tapi_env_process .. _doxid-group__tapi__env_1gaa31b99a97720d7df3d75125988a2737b: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_env_process` tapi_env_process Process entry on a host .. index:: pair: typedef; tapi_env_pco .. _doxid-group__tapi__env_1gac1afec991ec94c6454f8c005066c81c6: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_env_pco` tapi_env_pco Entry of PCO name to RPC server mapping .. index:: pair: typedef; tapi_env_addr .. _doxid-group__tapi__env_1ga68c8b2437f7d5669ca00126dc0dd6a0a: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_env_addr` tapi_env_addr Entry of address name to real address mapping .. index:: pair: typedef; tapi_env_alias .. _doxid-group__tapi__env_1gaf7d8eb85c54aa109a2072c025d9b5c66: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_env_alias` tapi_env_alias Alias in Socket API testing environment .. index:: pair: typedef; tapi_env .. _doxid-group__tapi__env_1ga3a864ae6a7dcffbd6941b347f82fa3be: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_env` tapi_env Environment for the test Global Functions ---------------- .. index:: pair: function; STAILQ_HEAD .. _doxid-group__tapi__env_1gaec22b57413230e7c9c7b26e258b80c4f: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef STAILQ_HEAD(cfg_handle_tqh, :ref:`cfg_handle_tqe`) Head of the tail queue with Cfgr handles .. index:: pair: function; SLIST_HEAD .. _doxid-group__tapi__env_1ga9b8b9fb17571661ffd4dde98d84a6e39: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef SLIST_HEAD(tapi_env_nets, :ref:`tapi_env_net`) List of required networks in environment .. index:: pair: function; SLIST_HEAD .. _doxid-group__tapi__env_1gafb56f8c7bec5a00afcbc39890e10d66c: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef SLIST_HEAD(tapi_env_processes, :ref:`tapi_env_process`) List of processes on a host .. index:: pair: function; SLIST_HEAD .. _doxid-group__tapi__env_1gae4c8aab102b98b2481d1332ca85c42bf: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef SLIST_HEAD(tapi_env_hosts, :ref:`tapi_env_host`) List of required hosts in environment .. index:: pair: function; CIRCLEQ_HEAD .. _doxid-group__tapi__env_1ga42f9e2db94cd5cfe634a73e175f48fed: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef CIRCLEQ_HEAD(tapi_env_ifs, :ref:`tapi_env_if`) List of host interfaces required in environment .. index:: pair: function; STAILQ_HEAD .. _doxid-group__tapi__env_1ga68af73a7150c3ee8edfdafcf62f57906: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef STAILQ_HEAD(tapi_env_ps_ifs, :ref:`tapi_env_ps_if`) List of process interfaces .. index:: pair: function; STAILQ_HEAD .. _doxid-group__tapi__env_1ga8b4692ad5b0274a64114b97870aff761: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef STAILQ_HEAD(tapi_env_pcos, :ref:`tapi_env_pco`) List of PCOs .. index:: pair: function; CIRCLEQ_HEAD .. _doxid-group__tapi__env_1ga1cd83d497946fbc8ea0b4af6d1f61afd: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef CIRCLEQ_HEAD(tapi_env_addrs, :ref:`tapi_env_addr`) List of addresses in environment .. index:: pair: function; SLIST_HEAD .. _doxid-group__tapi__env_1ga5d7da4b9f8c4a0a430d97493265e1a27: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef SLIST_HEAD(tapi_env_aliases, :ref:`tapi_env_alias`) List of aliases in environment .. index:: pair: function; tapi_env_init .. _doxid-group__tapi__env_1gace62d14620e8c188d001e5e2d67d301b: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_env_init(:ref:`tapi_env`* env) Initialize environment variable. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - env - Location for environment .. rubric:: Returns: Status code. .. index:: pair: function; tapi_env_get .. _doxid-group__tapi__env_1ga179afdbc7185e08f9b47da9e92c4d4fd: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_env_get(const char* cfg, :ref:`tapi_env`* env) Get Socket API test suite environment for the test. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - cfg - Environment configuration string * - env - Location for environment .. rubric:: Returns: Status code. .. index:: pair: function; tapi_env_get_rpcs_only .. _doxid-group__tapi__env_1ga5558d254e347eca97135f7f584ae6dd5: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_env_get_rpcs_only(const char* cfg, :ref:`tapi_env`* env) Get only RPC servers for the test suite environment. Unlike the :ref:`tapi_env_get() `, the function does not bind interfaces, addresses and sniffers. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - cfg - Environment configuration string * - env - Location for environment .. rubric:: Returns: Status code. .. index:: pair: function; tapi_env_allocate_addr .. _doxid-group__tapi__env_1gad6d3953864c27f5ba6551bf76f7abe03: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_env_allocate_addr(:ref:`tapi_env_net`* net, int af, struct sockaddr** addr, socklen_t* addrlen) Allocate new address from specified net. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - net - Net * - af - Family of the address to be allocated * - addr - Location for address pointer (allocated from heap) * - addrlen - Location for address length of NULL .. rubric:: Returns: Status code. .. index:: pair: function; tapi_env_free .. _doxid-group__tapi__env_1ga180162bb9f6f0c9e6bfd242f542eac8d: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_env_free(:ref:`tapi_env`* env) Free Socket API test suite environment. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - env - Environment .. rubric:: Returns: Status code. .. index:: pair: function; tapi_env_get_net .. _doxid-group__tapi__env_1gaa04e9c6f1257677d9700053431d63c3f: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`tapi_env_net`* tapi_env_get_net(:ref:`tapi_env`* env, const char* name) Get handle of the net from environment by name. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - env - Environment * - name - Name of the net .. rubric:: Returns: Handle of the net. .. index:: pair: function; tapi_env_get_host .. _doxid-group__tapi__env_1ga199595182fbbfa671e0b720f0781fc72: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`tapi_env_host`* tapi_env_get_host(:ref:`tapi_env`* env, const char* name) Get handle of the host from environment by name. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - env - Environment * - name - Name of the host .. rubric:: Returns: Handle of the host. .. index:: pair: function; tapi_env_get_pco .. _doxid-group__tapi__env_1gaa4719ce28d01c80c0853b5f7568eca45: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`rcf_rpc_server`* tapi_env_get_pco(:ref:`tapi_env`* env, const char* name) Get handle of PCO (RPC server) from environment by name. RPC server is automatically closed and handle becomes not valid when environment is freed. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - env - Environment * - name - Name of the PCO .. rubric:: Returns: Handle of the RPC server. .. index:: pair: function; tapi_env_get_addr .. _doxid-group__tapi__env_1gabf6f604e7b393440f5b2c2d4cf66e44a: .. ref-code-block:: cpp :class: doxyrest-title-code-block const struct sockaddr* tapi_env_get_addr(:ref:`tapi_env`* env, const char* name, socklen_t* addrlen) Get address from environment by name. Valid port is set in the structure as well. The structure should be copied, if user wants to modify its content. Pointer becomes not valid when environment is freed. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - env - Environment * - name - Name of the address in configuration string * - addrlen - Address length .. rubric:: Returns: Pointer to address structure. .. index:: pair: function; tapi_get_addr_type .. _doxid-group__tapi__env_1ga926de2d94df0d29ac8e3533f660b3390: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`tapi_env_addr_type` tapi_get_addr_type(:ref:`tapi_env`* env, const char* name) Get type address from environment by name. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - env - Environment * - name - Name of the address in configuration string .. rubric:: Returns: Type of address. .. index:: pair: function; tapi_env_get_if .. _doxid-group__tapi__env_1gaf220847fb7ec44d44439fa412a4db635: .. ref-code-block:: cpp :class: doxyrest-title-code-block const struct if_nameindex* tapi_env_get_if(:ref:`tapi_env`* env, const char* name) Get system name of the interface named in configuration string as 'name' argument. Pointer becomes not valid when environment is freed. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - env - Environment handle * - name - Name of the interface in environment .. rubric:: Returns: Pointer to the structure with interface name and index. .. index:: pair: function; tapi_env_get_env_if .. _doxid-group__tapi__env_1gaad2dc1650de106792ca5529d1cd09e10: .. ref-code-block:: cpp :class: doxyrest-title-code-block const :ref:`tapi_env_if`* tapi_env_get_env_if(:ref:`tapi_env`* env, const char* name) Get environment entity of the interface named in configuration string as 'name' argument. Pointer becomes not valid when environment is freed. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - env - Environment handle * - name - Name of the interface in environment .. rubric:: Returns: Pointer to the environment interface entity. .. index:: pair: function; tapi_env_get_br .. _doxid-group__tapi__env_1ga4986f866fa71d0311cdf558c8d936abf: .. ref-code-block:: cpp :class: doxyrest-title-code-block const struct if_nameindex* tapi_env_get_br(:ref:`tapi_env`* env, const char* name) Get system name of the bridge named in configuration string as 'name' argument. Pointer becomes not valid when environment is freed. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - env - Environment handle * - name - Name of the bridge in environment .. rubric:: Returns: Pointer to the structure with bridge name and index. .. index:: pair: function; tapi_env_get_ph .. _doxid-group__tapi__env_1ga9a52a800baefd7c10200fada230e0701: .. ref-code-block:: cpp :class: doxyrest-title-code-block const struct if_nameindex* tapi_env_get_ph(:ref:`tapi_env`* env, const char* name) Get system name of the physical interface named in configuration string as 'name' argument. Pointer becomes not valid when environment is freed. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - env - Environment handle * - name - Name of the physical interface in environment .. rubric:: Returns: Pointer to the structure with bridge name and index. .. index:: pair: function; tapi_env_get_net_host_addr .. _doxid-group__tapi__env_1ga0db154a4c73408baaa06aaacd6c2eba1: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_env_get_net_host_addr(const :ref:`tapi_env`* env, const :ref:`tapi_env_net`* net, const :ref:`tapi_env_host`* host, sa_family_t af, :ref:`tapi_cfg_net_assigned`* assigned, struct sockaddr** addr, socklen_t* addrlen) Get address assigned to the host in specified HW net and address space. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - env - Environment * - net - Environment net * - host - Environment host * - af - Address family of requested address * - assigned - Information about assigned addresses * - addr - Location for address pointer (OUT) * - addrlen - Address length (OUT) .. rubric:: Returns: Status code. .. index:: pair: function; tapi_env_rpcs2pco .. _doxid-group__tapi__env_1ga0349aaa60331f527e05c2018a6f60982: .. ref-code-block:: cpp :class: doxyrest-title-code-block const :ref:`tapi_env_pco`* tapi_env_rpcs2pco(const :ref:`tapi_env`* env, const :ref:`rcf_rpc_server`* rpcs) Find PCO by RPC server handle. .. index:: pair: function; tapi_env_add_addresses .. _doxid-group__tapi__env_1ga7cd4286971945ffbc788a97c7d212554: .. ref-code-block:: cpp :class: doxyrest-title-code-block struct sockaddr** tapi_env_add_addresses(:ref:`rcf_rpc_server`* rpcs, :ref:`tapi_env_net`* net, int af, const struct if_nameindex* iface, int addr_num) Allocate and add a number of addresses to the specified interface. The function does not roll back configuration changes in case of fail - the test execution should be aborted. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - rpcs - RPC server handle. * - net - Network addresses pool. * - af - Address family. * - iface - Interface handle. * - addr_num - Addresses number to be added. .. rubric:: Returns: Address pointers array or ``NULL`` in case of fail. .. index:: pair: function; tapi_env_foreach_if .. _doxid-group__tapi__env_1gab56464c2f6462c7ec7116920072218c9: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_env_foreach_if(:ref:`tapi_env`* env, tapi_env_foreach_if_fn* fn, void* opaque) Run over all interfaces mentioned in the environment and run a given function for each one. Hook can call :ref:`TEST_FAIL() ` if things go wrong. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - env - Environment * - fn - Hook pointer * - opaque - Hook-defined opaque .. index:: pair: function; tapi_env_nets_count .. _doxid-group__tapi__env_1ga89577b6b014ee70377a1fb8a7eaf48e6: .. ref-code-block:: cpp :class: doxyrest-title-code-block unsigned tapi_env_nets_count(:ref:`tapi_env`* env) Return total number of nets in the environment .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - env - Environment .. rubric:: Returns: Number of nets .. index:: pair: function; tapi_env_get_if_net_node .. _doxid-group__tapi__env_1gaa642a5b887934299fc9895b4db1be2ae: .. ref-code-block:: cpp :class: doxyrest-title-code-block const :ref:`cfg_net_node_t`* tapi_env_get_if_net_node(const :ref:`tapi_env_if`* iface) Return network node of an interface. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - iface - Network interface .. rubric:: Returns: Network node configuration Macros ------ .. index:: pair: define; CHECK_ADDR_FAKE .. _doxid-group__tapi__env_1ga2a7a5d7a169086e79bbc332a2eef73bf: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define CHECK_ADDR_FAKE(addr_, fake_) Check that the address is fake. Name of the variable must match name of the address in environment configuration string. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - addr\_ - address * - fake\_ - Whether the address has FAKE type (OUT) .. index:: pair: define; TEST_END_ENV .. _doxid-group__tapi__env_1ga0f660bc2b3be5be34af7c29a6867a3dc: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TEST_END_ENV Test suite specific part of the last action with 'env' support. .. index:: pair: define; TEST_GET_ADDR .. _doxid-group__tapi__env_1gaedbe2460b901ad0fcda034cd0c49fd03: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TEST_GET_ADDR(pco_, addr_) Get address and assign a free port. Name of the variable must match name of the address in environment configuration string. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - pco\_ - RPC server to use when checking the port (IN) * - addr\_ - address (const struct sockaddr \*) (OUT) .. index:: pair: define; TEST_GET_ADDR_NO_PORT .. _doxid-group__tapi__env_1gad817b7648f1354896c4838aef7e74392: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TEST_GET_ADDR_NO_PORT(addr_) Get address. Name of the variable must match name of the address in environment configuration string. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - addr\_ - address (const struct sockaddr \*) (OUT) .. index:: pair: define; TEST_GET_ADDR_REUSE_PORT .. _doxid-group__tapi__env_1ga16f4a73bd85ed9054cd38869d0e12c93: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TEST_GET_ADDR_REUSE_PORT(pco_, src_, addr_) Get address and assign port from another address. Names of the variables must match name of the addresses in environment configuration string. Source address must already be initialized. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - pco\_ - RPC server to use when checking the port. * - src\_ - Address whose port to use (const struct sockaddr \*). * - addr\_ - Address (const struct sockaddr \*). .. index:: pair: define; TEST_GET_BR .. _doxid-group__tapi__env_1gab0efe74e68206344d306fba59e6d42b7: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TEST_GET_BR(if_, br_) Get XEN bridge. Name of the variable must match name of the XEN bridge in environment configuration string. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - br\_ - XEN bridge (const struct if_nameindex \*) (OUT) .. index:: pair: define; TEST_GET_ENV_IF .. _doxid-group__tapi__env_1gac03dfcea09c25456e30d9d7e09fe4309: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TEST_GET_ENV_IF(env_if_) Get environment interface entity. Name of the variable must match name of the interface in environment configuration string. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - env_if\_ - interface (const :ref:`tapi_env_if ` \*) (OUT) .. index:: pair: define; TEST_GET_HOST .. _doxid-group__tapi__env_1ga487062da978512a9c6ee31e8b37de3f1: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TEST_GET_HOST(host_) Get named host from environment. Name of the variable must match name of the host in environment configuration string. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - host\_ - Pointer to :ref:`tapi_env_host ` (OUT) .. index:: pair: define; TEST_GET_IF .. _doxid-group__tapi__env_1gad8a31fa1928ad20a31c0deae3dd9bcd7: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TEST_GET_IF(if_) Get interface. Name of the variable must match name of the interface in environment configuration string. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - if\_ - interface (const struct if_nameindex \*) (OUT) .. index:: pair: define; TEST_GET_LINK_ADDR .. _doxid-group__tapi__env_1ga662384bb49b738b0f5ead0fe8c84aa3b: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TEST_GET_LINK_ADDR(addr_) Get the value of link-layer address parameter. Name of the variable must match name of the address in environment configuration string. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - addr\_ - address (const unsigned char \*) (OUT) .. index:: pair: define; TEST_GET_NET .. _doxid-group__tapi__env_1ga869dffb03e827b5d68c97d7a29730b47: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TEST_GET_NET(net_) Get network. Name of the variable must match name of the network in environment configuration string. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - net\_ - Pointer to :ref:`tapi_env_net ` (OUT) .. index:: pair: define; TEST_GET_PCO .. _doxid-group__tapi__env_1ga8f5bdad78eb1598640d07d1121e40551: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TEST_GET_PCO(rpcs_) Get PCO (RPC server) handle. Name of the variable must match name of the PCO in environment configuration string. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - rpcs\_ - RPC server handle (OUT) .. index:: pair: define; TEST_GET_PH .. _doxid-group__tapi__env_1gaf5a053490a0285f684b9568d10c22735: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TEST_GET_PH(if_, ph_) Get XEN physical interface. Name of the variable must match name of the XEN physical interface in environment configuration string. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ph\_ - XEN physical interface (const struct if_nameindex \*) (OUT) .. index:: pair: define; TEST_START_ENV .. _doxid-group__tapi__env_1ga70b24d60dabe841545b5018ae913cdc1: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TEST_START_ENV Test suite specific the first actions of the test with 'env' support. .. index:: pair: define; TEST_START_ENV_VARS .. _doxid-group__tapi__env_1ga61ea7abaf16a942d5bbf16fa10cd266f: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TEST_START_ENV_VARS Test suite specific variables with 'env' support.