:orphan: .. index:: pair: group; Neighbour table configuration .. _doxid-group__tapi__conf__neigh: Neighbour table configuration ============================= .. toctree:: :hidden: Overview ~~~~~~~~ .. ref-code-block:: cpp :class: doxyrest-overview-code-block // global functions :ref:`te_errno` :ref:`tapi_cfg_get_neigh_entry`(const char* ta, const char* ifname, const struct sockaddr* net_addr, void* ret_addr, bool* is_static, :ref:`cs_neigh_entry_state`* state); :ref:`te_errno` :ref:`tapi_cfg_add_neigh_entry`(const char* ta, const char* ifname, const struct sockaddr* net_addr, const void* link_addr, bool is_static); :ref:`te_errno` :ref:`tapi_cfg_set_neigh_entry`(const char* ta, const char* ifname, const struct sockaddr* net_addr, const void* link_addr, bool is_static); :ref:`te_errno` :ref:`tapi_cfg_del_neigh_entry`(const char* ta, const char* ifname, const struct sockaddr* net_addr); :ref:`te_errno` :ref:`tapi_cfg_del_neigh_dynamic`(const char* ta, const char* ifname); :ref:`te_errno` :ref:`tapi_cfg_add_neigh_proxy`(const char* ta, const char* ifname, const struct sockaddr* net_addr, :ref:`cfg_handle`* p_handle); .. _details-group__tapi__conf__neigh: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Global Functions ---------------- .. index:: pair: function; tapi_cfg_get_neigh_entry .. _doxid-group__tapi__conf__neigh_1gab775cbea6c7bb5ec54f6addc9d42c77b: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_get_neigh_entry(const char* ta, const char* ifname, const struct sockaddr* net_addr, void* ret_addr, bool* is_static, :ref:`cs_neigh_entry_state`* state) Get neighbour entry. Currently the function supports only (IP -> IEEE 802.3 ethernet) entries. In the future it might be extended with an additional parameter hw_type to support different classes of link layer addresses. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - ifname - Interface name * - net_addr - IP address * - ret_addr - Returned IEEE 802.3 Link layer address * - is_static - NULL or location for a flag: is found entry static? * - state - NULL or location for state of dynamic entry * - 0 - on success .. rubric:: Returns: Status code .. index:: pair: function; tapi_cfg_add_neigh_entry .. _doxid-group__tapi__conf__neigh_1ga7f3d9a8d832a7059b7b8dfa543d4b57e: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_add_neigh_entry(const char* ta, const char* ifname, const struct sockaddr* net_addr, const void* link_addr, bool is_static) Add a new neighbour entry. Currently the function supports only (IP -> IEEE 802.3 ethernet) entries. In the future it might be extended with an additional parameter hw_type to support different classes of link layer addresses. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - ifname - Interface name * - net_addr - IP address * - link_addr - IEEE 802.3 Link layer address * - is_static - Is static (or dynamic) entry should be added * - 0 - - on success .. rubric:: Returns: Status code .. index:: pair: function; tapi_cfg_set_neigh_entry .. _doxid-group__tapi__conf__neigh_1gaaaa4bdce53a169a0373bd1263d4ad2c1: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_set_neigh_entry(const char* ta, const char* ifname, const struct sockaddr* net_addr, const void* link_addr, bool is_static) Set a new value for neighbour entry. Currently the function supports only (IP -> IEEE 802.3 ethernet) entries. In the future it might be extended with an additional parameter hw_type to support different classes of link layer addresses. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - ifname - Interface name * - net_addr - IP address * - link_addr - IEEE 802.3 Link layer address * - is_static - Whether static or dynamic entry should be set * - 0 - - on success .. rubric:: Returns: Status code .. index:: pair: function; tapi_cfg_del_neigh_entry .. _doxid-group__tapi__conf__neigh_1ga2eb22702d218397c4a03132dea10aee1: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_del_neigh_entry(const char* ta, const char* ifname, const struct sockaddr* net_addr) Delete a neighbour entry. Currently the function supports only (IP -> IEEE 802.3 ethernet) entries. In the future it might be extended with an additional parameter address_family to support different classes of link layer addresses. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - ifname - Interface name * - net_addr - IP address * - 0 - - on success .. rubric:: Returns: Status code .. index:: pair: function; tapi_cfg_del_neigh_dynamic .. _doxid-group__tapi__conf__neigh_1ga4161e44ed18ac1cca9feb318a79f8438: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_del_neigh_dynamic(const char* ta, const char* ifname) Clenup dynamic neighbour entries. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent name * - ifname - Interface name or NULL if all interfaces should be processed * - 0 - - on success .. rubric:: Returns: Status code .. index:: pair: function; tapi_cfg_add_neigh_proxy .. _doxid-group__tapi__conf__neigh_1ga4b1e9ba06f74f9aa435a94b2fce4ae5c: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_add_neigh_proxy(const char* ta, const char* ifname, const struct sockaddr* net_addr, :ref:`cfg_handle`* p_handle) Add neighbor proxy entry for a given interface. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name. * - ifname - Interface name. * - net_addr - Network address to proxy. * - p_handle - Where to save pointer to configuration handle (may be ``NULL``). .. rubric:: Returns: Status code.