:orphan: .. index:: pair: group; Manipulation of network address pools .. _doxid-group__tapi__conf__net__pool: Manipulation of network address pools ===================================== .. toctree:: :hidden: Overview ~~~~~~~~ .. ref-code-block:: cpp :class: doxyrest-overview-code-block // global functions int :ref:`tapi_cfg_alloc_entry`(const char* parent_oid, :ref:`cfg_handle`* entry); int :ref:`tapi_cfg_free_entry`(:ref:`cfg_handle`* entry); static int :ref:`tapi_cfg_alloc_ip4_net`(:ref:`cfg_handle`* entry); static int :ref:`tapi_cfg_alloc_ip6_net`(:ref:`cfg_handle`* entry); :ref:`te_errno` :ref:`tapi_cfg_alloc_net`(int af, :ref:`cfg_handle`* entry); :ref:`te_errno` :ref:`tapi_cfg_add_net`(const char* net_pool, const struct sockaddr* net_addr, unsigned int prefix, int state, :ref:`cfg_handle`* entry); static :ref:`te_errno` :ref:`tapi_cfg_add_ip4_net`(const struct sockaddr_in* ip4_net_addr, unsigned int prefix, int state, :ref:`cfg_handle`* entry); static :ref:`te_errno` :ref:`tapi_cfg_add_ip6_net`(const struct sockaddr_in6* ip6_net_addr, unsigned int prefix, int state, :ref:`cfg_handle`* entry); int :ref:`tapi_cfg_alloc_net_addr`(:ref:`cfg_handle` net_pool_entry, :ref:`cfg_handle`* p_entry, struct sockaddr** addr); int :ref:`tapi_cfg_add_net_addr`(:ref:`cfg_handle` net_pool_entry, struct sockaddr* add_addr, :ref:`cfg_handle`* p_entry); .. _details-group__tapi__conf__net__pool: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Global Functions ---------------- .. index:: pair: function; tapi_cfg_alloc_entry .. _doxid-group__tapi__conf__net__pool_1gaa7328a3cbf164807daeb01b72042c13d: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_cfg_alloc_entry(const char* parent_oid, :ref:`cfg_handle`* entry) Get Configurator handle of free child. The function assumes that all children of the parent has integer value. Zero value is considered as the child is free. The child is marked as non-free by set of 1 as the child value. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - parent_oid - Parent instance OID * - entry - Location for entry handle .. rubric:: Returns: Status code. .. rubric:: See also: :ref:`tapi_cfg_free_entry ` .. index:: pair: function; tapi_cfg_free_entry .. _doxid-group__tapi__conf__net__pool_1ga975383a81eeaf61a77372567ab35e375: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_cfg_free_entry(:ref:`cfg_handle`* entry) Free earlier allocated child. Entry handle is set to CFG_HANDLE_INVALID on success. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - entry - Location of entry handle .. rubric:: Returns: Status code. .. rubric:: See also: :ref:`tapi_cfg_alloc_entry ` .. index:: pair: function; tapi_cfg_alloc_ip4_net .. _doxid-group__tapi__conf__net__pool_1ga2e02d19ee17f4ce3c16b6e231d57c08f: .. ref-code-block:: cpp :class: doxyrest-title-code-block static int tapi_cfg_alloc_ip4_net(:ref:`cfg_handle`* entry) Allocate entry in IPv4 subnets pool. Use :ref:`tapi_cfg_free_entry ` function to free allocated entry. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - entry - Location for Cfgr handle .. rubric:: Returns: Status code. .. rubric:: See also: :ref:`tapi_cfg_free_entry `, :ref:`tapi_cfg_alloc_net_addr ` .. index:: pair: function; tapi_cfg_alloc_ip6_net .. _doxid-group__tapi__conf__net__pool_1ga0a3e396ba911df3affce29477713b344: .. ref-code-block:: cpp :class: doxyrest-title-code-block static int tapi_cfg_alloc_ip6_net(:ref:`cfg_handle`* entry) Allocate entry in IPv6 subnets pool. Use :ref:`tapi_cfg_free_entry ` function to free allocated entry. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - entry - Location for Cfgr handle .. rubric:: Returns: Status code. .. rubric:: See also: :ref:`tapi_cfg_free_entry `, :ref:`tapi_cfg_alloc_net_addr ` .. index:: pair: function; tapi_cfg_alloc_net .. _doxid-group__tapi__conf__net__pool_1ga506088e36a0200e6cf7a4da52492e6ce: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_alloc_net(int af, :ref:`cfg_handle`* entry) Allocate entry in IPv4 or IPv6 subnets pool. Use :ref:`tapi_cfg_free_entry() ` function to free allocated entry. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - af - ``AF_INET`` or ``AF_INET6`` * - entry - Location for Configurator handle .. rubric:: Returns: Status code. .. index:: pair: function; tapi_cfg_add_net .. _doxid-group__tapi__conf__net__pool_1ga9b23d16df5b5e11f5d2247ed028b355f: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_add_net(const char* net_pool, const struct sockaddr* net_addr, unsigned int prefix, int state, :ref:`cfg_handle`* entry) Add entry to IPv4 or IPv6 subnets pool. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - net_pool - Name of the pool * - net_addr - Network address (or any network node address) * - prefix - Network address prefix * - state - Pool entry initial state (0 or 1) * - entry - Location for Cfgr handle of new entry .. rubric:: Returns: Status code. .. index:: pair: function; tapi_cfg_add_ip4_net .. _doxid-group__tapi__conf__net__pool_1ga525b597174f16d219cd23ddb339a1dba: .. ref-code-block:: cpp :class: doxyrest-title-code-block static :ref:`te_errno` tapi_cfg_add_ip4_net(const struct sockaddr_in* ip4_net_addr, unsigned int prefix, int state, :ref:`cfg_handle`* entry) Add entry to IPv4 subnets pool. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ip4_net_addr - Network address (or any network node address) * - prefix - Network address prefix * - state - Pool entry initial state (0 or 1) * - entry - Location for Cfgr handle of new entry .. rubric:: Returns: Status code. .. index:: pair: function; tapi_cfg_add_ip6_net .. _doxid-group__tapi__conf__net__pool_1gaed5e2e28ea23568757dac075ceaf23ce: .. ref-code-block:: cpp :class: doxyrest-title-code-block static :ref:`te_errno` tapi_cfg_add_ip6_net(const struct sockaddr_in6* ip6_net_addr, unsigned int prefix, int state, :ref:`cfg_handle`* entry) Add entry to IPv6 subnets pool. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ip6_net_addr - Network address (or any network node address) * - prefix - Network address prefix * - state - Pool entry initial state (0 or 1) * - entry - Location for Cfgr handle of new entry .. rubric:: Returns: Status code. .. index:: pair: function; tapi_cfg_alloc_net_addr .. _doxid-group__tapi__conf__net__pool_1ga467820d2298426864037ee48e2c059cd: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_cfg_alloc_net_addr(:ref:`cfg_handle` net_pool_entry, :ref:`cfg_handle`* p_entry, struct sockaddr** addr) Allocate IPv4 address from IPv4 subnet got from IPv4 subnets pool. Use :ref:`tapi_cfg_free_entry ` function to free allocated entry. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - net_pool_entry - Subnet handle * - p_entry - Location for Cfgr handle of new entry * - addr - Location for allocated address .. rubric:: Returns: Status code. .. rubric:: See also: :ref:`tapi_cfg_free_entry `, :ref:`tapi_cfg_alloc_ip4_net ` .. index:: pair: function; tapi_cfg_add_net_addr .. _doxid-group__tapi__conf__net__pool_1ga1b9c00451efb7588d6e953388aa9c724: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_cfg_add_net_addr(:ref:`cfg_handle` net_pool_entry, struct sockaddr* add_addr, :ref:`cfg_handle`* p_entry) Add IPv4 address to IPv4 subnet from IPv4 subnets pool. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - net_pool_entry - Subnet handle * - add_addr - Address to add in pool * - p_entry - Location for Cfgr handle of new entry .. rubric:: Returns: Status code.