DHCP client context. More...
#include <dhcp_client.h>
Data Fields | |
| NetContext * | netContext |
| TCP/IP stack context. More... | |
| NetInterface * | interface |
| Network interface to configure. More... | |
| uint_t | ipAddrIndex |
| Index of the IP address to be configured. More... | |
| bool_t | rapidCommit |
| Quick configuration using rapid commit. More... | |
| bool_t | manualDnsConfig |
| Force manual DNS configuration. More... | |
| systime_t | configTimeout |
| DHCP configuration timeout. More... | |
| DhcpClientTimeoutCallback | timeoutEvent |
| DHCP configuration timeout event. More... | |
| DhcpClientLinkChangeCallback | linkChangeEvent |
| Link state change event. More... | |
| DhcpClientStateChangeCallback | stateChangeEvent |
| FSM state change event. More... | |
| DhcpClientAddOptionsCallback | addOptionsCallback |
| Add DHCP options callback. More... | |
| DhcpClientParseOptionsCallback | parseOptionsCallback |
| Parse DHCP options callback. More... | |
| bool_t | running |
| Operational state of the DHCP client. More... | |
| DhcpState | state |
| Current state of the FSM. More... | |
| bool_t | timeoutEventDone |
| Timeout callback function has been called. More... | |
| systime_t | timestamp |
| Timestamp to manage retransmissions. More... | |
| systime_t | timeout |
| Timeout value. More... | |
| systime_t | retransmitTimeout |
| Retransmission timeout. More... | |
| uint_t | retransmitCount |
| Retransmission counter. More... | |
| Ipv4Addr | serverIpAddr |
| DHCP server IPv4 address. More... | |
| Ipv4Addr | requestedIpAddr |
| Requested IPv4 address. More... | |
| uint32_t | transactionId |
| Value to match requests with replies. More... | |
| systime_t | configStartTime |
| Address acquisition or renewal process start time. More... | |
| systime_t | leaseStartTime |
| Lease start time. More... | |
| uint32_t | leaseTime |
| Lease time. More... | |
| uint32_t | t1 |
| Time at which the client enters the RENEWING state. More... | |
| uint32_t | t2 |
| Time at which the client enters the REBINDING state. More... | |
Detailed Description
DHCP client context.
Definition at line 235 of file dhcp_client.h.
Field Documentation
◆ addOptionsCallback
| DhcpClientAddOptionsCallback addOptionsCallback |
Add DHCP options callback.
Definition at line 246 of file dhcp_client.h.
◆ configStartTime
| systime_t configStartTime |
Address acquisition or renewal process start time.
Definition at line 258 of file dhcp_client.h.
◆ configTimeout
| systime_t configTimeout |
DHCP configuration timeout.
Definition at line 242 of file dhcp_client.h.
◆ interface
| NetInterface* interface |
Network interface to configure.
Definition at line 238 of file dhcp_client.h.
◆ ipAddrIndex
| uint_t ipAddrIndex |
Index of the IP address to be configured.
Definition at line 239 of file dhcp_client.h.
◆ leaseStartTime
| systime_t leaseStartTime |
Lease start time.
Definition at line 259 of file dhcp_client.h.
◆ leaseTime
| uint32_t leaseTime |
Lease time.
Definition at line 260 of file dhcp_client.h.
◆ linkChangeEvent
| DhcpClientLinkChangeCallback linkChangeEvent |
Link state change event.
Definition at line 244 of file dhcp_client.h.
◆ manualDnsConfig
| bool_t manualDnsConfig |
Force manual DNS configuration.
Definition at line 241 of file dhcp_client.h.
◆ netContext
| NetContext* netContext |
TCP/IP stack context.
Definition at line 237 of file dhcp_client.h.
◆ parseOptionsCallback
| DhcpClientParseOptionsCallback parseOptionsCallback |
Parse DHCP options callback.
Definition at line 247 of file dhcp_client.h.
◆ rapidCommit
| bool_t rapidCommit |
Quick configuration using rapid commit.
Definition at line 240 of file dhcp_client.h.
◆ requestedIpAddr
| Ipv4Addr requestedIpAddr |
Requested IPv4 address.
Definition at line 256 of file dhcp_client.h.
◆ retransmitCount
| uint_t retransmitCount |
Retransmission counter.
Definition at line 254 of file dhcp_client.h.
◆ retransmitTimeout
| systime_t retransmitTimeout |
Retransmission timeout.
Definition at line 253 of file dhcp_client.h.
◆ running
| bool_t running |
Operational state of the DHCP client.
Definition at line 248 of file dhcp_client.h.
◆ serverIpAddr
| Ipv4Addr serverIpAddr |
DHCP server IPv4 address.
Definition at line 255 of file dhcp_client.h.
◆ state
| DhcpState state |
Current state of the FSM.
Definition at line 249 of file dhcp_client.h.
◆ stateChangeEvent
| DhcpClientStateChangeCallback stateChangeEvent |
FSM state change event.
Definition at line 245 of file dhcp_client.h.
◆ t1
| uint32_t t1 |
Time at which the client enters the RENEWING state.
Definition at line 261 of file dhcp_client.h.
◆ t2
| uint32_t t2 |
Time at which the client enters the REBINDING state.
Definition at line 262 of file dhcp_client.h.
◆ timeout
| systime_t timeout |
Timeout value.
Definition at line 252 of file dhcp_client.h.
◆ timeoutEvent
| DhcpClientTimeoutCallback timeoutEvent |
DHCP configuration timeout event.
Definition at line 243 of file dhcp_client.h.
◆ timeoutEventDone
| bool_t timeoutEventDone |
Timeout callback function has been called.
Definition at line 250 of file dhcp_client.h.
◆ timestamp
| systime_t timestamp |
Timestamp to manage retransmissions.
Definition at line 251 of file dhcp_client.h.
◆ transactionId
| uint32_t transactionId |
Value to match requests with replies.
Definition at line 257 of file dhcp_client.h.
The documentation for this struct was generated from the following file:
- cyclone_tcp/dhcp/dhcp_client.h