Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Data Structures | Macros | Enumerations | Functions
openapi_dhcp_server.h File Reference
#include "openapi_common.h"

Go to the source code of this file.

Data Structures

struct  OPEN_DHCP_SERVER_CLIENT_ID_t
 DHCP client ID. More...
 
struct  OPEN_DHCP_SERVER_POOL_NAME_t
 DHCP Pool name. More...
 

Macros

#define OPEN_DHCP_SERVER_CLIENT_ID_MAXLEN   256 /** Maximum client ID, includes terminating '\0' */
 
#define OPEN_DHCP_SERVER_POOL_NAME_MAXLEN   32 /** Maximum pool name, includes terminating '\0' */
 

Enumerations

enum  OPEN_DHCP_SERVER_LEASE_STATE_t {
  OPEN_DHCP_SERVER_FREE_LEASE = 0, OPEN_DHCP_SERVER_ACTIVE_LEASE = 1, OPEN_DHCP_SERVER_OFFERED_LEASE = 2, OPEN_DHCP_SERVER_EXPIRED_LEASE = 3,
  OPEN_DHCP_SERVER_ABANDONED_LEASE = 4
}
 DHCP server lease states. More...
 
enum  OPEN_DHCP_SERVER_POOL_TYPE_t { OPEN_DHCP_SERVER_POOL_TYPE_INACTIVE = 0, OPEN_DHCP_SERVER_POOL_TYPE_DYNAMIC = 1, OPEN_DHCP_SERVER_POOL_TYPE_MANUAL = 2 }
 Pool types. More...
 
enum  OPEN_DHCPS_STAT_ID_t {
  OPEN_DHCPS_STAT_ID_RESERVED = 0, OPEN_DHCPS_STAT_ID_ACTIVE_LEASES = 1, OPEN_DHCPS_STAT_ID_EXPIRED_LEASES = 2, OPEN_DHCPS_STAT_ID_MALFORMED_MSGS = 3,
  OPEN_DHCPS_STAT_ID_DISCOVER_DROPPED = 4, OPEN_DHCPS_STAT_ID_RX_DISCOVER = 5, OPEN_DHCPS_STAT_ID_RX_REQUEST = 6, OPEN_DHCPS_STAT_ID_RX_DECLINE = 7,
  OPEN_DHCPS_STAT_ID_RX_RELEASE = 8, OPEN_DHCPS_STAT_ID_RX_INFORM = 9, OPEN_DHCPS_STAT_ID_TX_OFFER = 10, OPEN_DHCPS_STAT_ID_TX_ACK = 11,
  OPEN_DHCPS_STAT_ID_TX_NACK = 12, OPEN_DHCPS_STAT_ID_LAST
}
 DHCP Server Statistic IDs. More...
 

Functions

open_error_t openapiDhcpServerLeaseDataGet (openapiClientHandle_t *client_handle, open_inet_addr_t *ipaddr, uint32_t *mask, open_buffdesc *hwaddr, OPEN_DHCP_SERVER_CLIENT_ID_t *clientId, OPEN_DHCP_SERVER_POOL_NAME_t *poolName, uint32_t *remaining)
 Get the DHCP Server Lease Data. More...
 
open_error_t openapiDhcpServerLeaseEntryFirstGet (openapiClientHandle_t *client_handle, OPEN_DHCP_SERVER_POOL_NAME_t *poolName, uint32_t *leaseIndex, open_inet_addr_t *ipaddr, OPEN_DHCP_SERVER_LEASE_STATE_t *state)
 Get the first DHCP Server Lease Entry. More...
 
open_error_t openapiDhcpServerLeaseEntryNextGet (openapiClientHandle_t *client_handle, OPEN_DHCP_SERVER_POOL_NAME_t *poolName, uint32_t *leaseIndex, open_inet_addr_t *ipaddr, OPEN_DHCP_SERVER_LEASE_STATE_t *state)
 Get the next DHCP Server Lease Entry. More...
 
open_error_t openapiDhcpServerPoolEntryFirstGet (openapiClientHandle_t *client_handle, uint32_t *poolIndex, OPEN_DHCP_SERVER_POOL_NAME_t *poolName)
 Get the first DHCP Server Pool Entry. More...
 
open_error_t openapiDhcpServerPoolEntryNextGet (openapiClientHandle_t *client_handle, uint32_t *poolIndex, OPEN_DHCP_SERVER_POOL_NAME_t *poolName)
 Get the next DHCP Server Pool Entry. More...
 
open_error_t openapiDhcpServerPoolTypeGet (openapiClientHandle_t *client_handle, OPEN_DHCP_SERVER_POOL_NAME_t *poolName, OPEN_DHCP_SERVER_POOL_TYPE_t *type)
 Get the DHCP Server Pool Type. More...
 
open_error_t openapiDhcpServerStatGet (openapiClientHandle_t *client_handle, OPEN_DHCPS_STAT_ID_t id, uint32_t *val)
 Get the specified DHCP Server statistic. More...