libdhcp_control_s Struct Reference
[libdhcp library interface]

#include <libdhcp.h>


Data Fields

LIBDHCP_Callback callback
uint16_t capability
uint8_t finished
uint8_t decline
time_t timeout
time_t now
void * arg
LIBDHCP_Error_Handler eh
uint8_t log_level


Detailed Description

LIBDHCP_Control

The libdhcp DHCP client control structure. Each client is called with a pointer to this structure as the first argument to its main dhcp*_client function. This structure specifies what the client is allowed to do and how it will communicate state changes to the calling code.

Definition at line 84 of file libdhcp.h.


Field Documentation

void* libdhcp_control_s::arg

user data pointer

Definition at line 94 of file libdhcp.h.

Referenced by dhcp6_nic_callback(), dhcp6_nic_from_lease(), do_dhcpv6(), and libdhcp_control_new().

LIBDHCP_Callback libdhcp_control_s::callback

the DHCP clients' main loop calls this on state changes

Definition at line 88 of file libdhcp.h.

Referenced by libdhcp_control_new().

uint16_t libdhcp_control_s::capability

LIBDHCP_Capability bits to enable

Definition at line 89 of file libdhcp.h.

Referenced by libdhcp_control_new().

uint8_t libdhcp_control_s::decline

set to one to decline the lease (DHCPv4 only)

Definition at line 91 of file libdhcp.h.

LIBDHCP_Error_Handler libdhcp_control_s::eh

The logger / error hander callback

Definition at line 95 of file libdhcp.h.

Referenced by libdhcp_control_new().

uint8_t libdhcp_control_s::finished

set to one to make clients exit their main loop

Definition at line 90 of file libdhcp.h.

uint8_t libdhcp_control_s::log_level

maximum log level (LOG_FATAL excluded)

Definition at line 97 of file libdhcp.h.

Referenced by libdhcp_control_new(), libdhcp_stderr_logger(), and libdhcp_syslogger().

time_t libdhcp_control_s::now

clients set this to time(0) on entering main loop

Definition at line 93 of file libdhcp.h.

time_t libdhcp_control_s::timeout

(timeout+now) == time after which clients MUST return

Definition at line 92 of file libdhcp.h.

Referenced by libdhcp_control_new().


The documentation for this struct was generated from the following file:
Generated on Thu Aug 10 21:26:26 2006 for libdhcp by  doxygen 1.4.7