Network Component  Version 7.5.0
MDK Middleware for IPv4 and IPv6 Networking
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
NetDHCP6: DHCP6 Client

Events generated by the Network - Dynamic Host Configuration Client for IPv6 functions. More...

Functions

__STATIC_INLINE void EvrNetDHCP6_InitClient (uint8_t option_flags)
 Event on DHCP6 client initialize (Op) More...
 
__STATIC_INLINE void EvrNetDHCP6_GetSocketFailed (void)
 Event on DHCP6 client failed to allocate UDP socket (Error) More...
 
__STATIC_INLINE void EvrNetDHCP6_StartClient (uint32_t mode)
 Event on DHCP6 client start (Op) More...
 
__STATIC_INLINE void EvrNetDHCP6_StopClient (void)
 Event on DHCP6 client stop (Op) More...
 
__STATIC_INLINE void EvrNetDHCP6_ClientState (uint32_t state)
 Event on DHCP6 client indication of client state (Op) More...
 
__STATIC_INLINE void EvrNetDHCP6_NextState (uint32_t state)
 Event on DHCP6 client transition to next state (Op) More...
 
__STATIC_INLINE void EvrNetDHCP6_NextStateDelay (uint32_t state, uint32_t delay)
 Event on DHCP6 client transition to next state with random delay(Op) More...
 
__STATIC_INLINE void EvrNetDHCP6_ChangeStateLinkDown (uint32_t state)
 Event on DHCP6 client change state on link-down (Op) More...
 
__STATIC_INLINE void EvrNetDHCP6_NoAddressAvailable (uint32_t state)
 Event on DHCP6 client no address available status received (Op) More...
 
__STATIC_INLINE void EvrNetDHCP6_StateRetransmit (uint32_t state)
 Event on DHCP6 client retransmit request in current state (Op) More...
 
__STATIC_INLINE void EvrNetDHCP6_StateTimeout (uint32_t state)
 Event on DHCP6 client timeout in current state (Op) More...
 
__STATIC_INLINE void EvrNetDHCP6_ChangeStateOnTimeout (uint32_t current, uint32_t next)
 Event on DHCP6 client state timeout and transit to next state (Op) More...
 
__STATIC_INLINE void EvrNetDHCP6_T1Expired (uint32_t state)
 Event on DHCP6 client timer T1 expired (Op) More...
 
__STATIC_INLINE void EvrNetDHCP6_T2Expired (uint32_t state)
 Event on DHCP6 client timer T2 expired (Op) More...
 
__STATIC_INLINE void EvrNetDHCP6_SendDhcpMessage (uint8_t msg_type)
 Event on DHCP6 client send message (Op) More...
 
__STATIC_INLINE void EvrNetDHCP6_ReceiveFrame (uint32_t length)
 Event on DHCP6 client receive frame (Op) More...
 
__STATIC_INLINE void EvrNetDHCP6_FrameTooShort (uint32_t length, uint32_t min_length)
 Event on DHCP6 client received frame too short (Error) More...
 
__STATIC_INLINE void EvrNetDHCP6_WrongTransactionId (uint32_t xid, uint32_t xid_valid)
 Event on DHCP6 client wrong transaction identifier (XID) received (Error) More...
 
__STATIC_INLINE void EvrNetDHCP6_UnknownMessageType (uint8_t msg_type)
 Event on DHCP6 client unknown message type received (Error) More...
 
__STATIC_INLINE void EvrNetDHCP6_ShowMessage (uint8_t msg_type, uint32_t xid)
 Event on DHCP6 client display message information (Op) More...
 
__STATIC_INLINE void EvrNetDHCP6_InvalidMessageType (uint8_t msg_type)
 Event on DHCP6 client invalid message type received (Op) More...
 
__STATIC_INLINE void EvrNetDHCP6_WrongClientId (void)
 Event on DHCP6 client wrong client identifier received (Op) More...
 
__STATIC_INLINE void EvrNetDHCP6_ServerNotChosen (void)
 Event on DHCP6 client server not chosen in DISCOVER, REBIND state (Op) More...
 
__STATIC_INLINE void EvrNetDHCP6_StatusCode (uint16_t status)
 Event on DHCP6 client option status code received (Op) More...
 
__STATIC_INLINE void EvrNetDHCP6_WrongServerId (void)
 Event on DHCP6 client wrong server identifier received (Op) More...
 
__STATIC_INLINE void EvrNetDHCP6_ShowDnsServers (const uint8_t *dns_list)
 Event on DHCP6 client display DNS server addresses (Op) More...
 
__STATIC_INLINE void EvrNetDHCP6_MissingServerId (void)
 Event on DHCP6 client missing server identifier option (Op) More...
 
__STATIC_INLINE void EvrNetDHCP6_WrongIaid (uint32_t iaid)
 Event on DHCP6 client wrong Identity Association Identifier (IAID) received (Op) More...
 
__STATIC_INLINE void EvrNetDHCP6_ShowIanaOffer (const void *iana_offer)
 Event on DHCP6 client display IANA offer (Op) More...
 
__STATIC_INLINE void EvrNetDHCP6_OfferTimerCheckFailed (void)
 Event on DHCP6 client offer address timer check failed (Error) More...
 

Description

Events generated by the Network - Dynamic Host Configuration Client for IPv6 functions.

Function Documentation

__STATIC_INLINE void EvrNetDHCP6_ChangeStateLinkDown ( uint32_t  state)

Event on DHCP6 client change state on link-down (Op)

Parameters
statenext state
__STATIC_INLINE void EvrNetDHCP6_ChangeStateOnTimeout ( uint32_t  current,
uint32_t  next 
)

Event on DHCP6 client state timeout and transit to next state (Op)

Parameters
currentcurrent state
nextnext state
__STATIC_INLINE void EvrNetDHCP6_ClientState ( uint32_t  state)

Event on DHCP6 client indication of client state (Op)

Parameters
statecurrent state
__STATIC_INLINE void EvrNetDHCP6_FrameTooShort ( uint32_t  length,
uint32_t  min_length 
)

Event on DHCP6 client received frame too short (Error)

Parameters
lengthframe length in bytes
min_lengthminimum length of the frame
__STATIC_INLINE void EvrNetDHCP6_GetSocketFailed ( void  )

Event on DHCP6 client failed to allocate UDP socket (Error)

__STATIC_INLINE void EvrNetDHCP6_InitClient ( uint8_t  option_flags)

Event on DHCP6 client initialize (Op)

Parameters
option_flagsDHCPv6 client option flags
  • 0x01: Opt.67 Vendor Class
__STATIC_INLINE void EvrNetDHCP6_InvalidMessageType ( uint8_t  msg_type)

Event on DHCP6 client invalid message type received (Op)

Parameters
msg_typemessage type
Note
Silently discard other message types.
__STATIC_INLINE void EvrNetDHCP6_MissingServerId ( void  )

Event on DHCP6 client missing server identifier option (Op)

Note
Silently discard the message.
__STATIC_INLINE void EvrNetDHCP6_NextState ( uint32_t  state)

Event on DHCP6 client transition to next state (Op)

Parameters
statenext state
__STATIC_INLINE void EvrNetDHCP6_NextStateDelay ( uint32_t  state,
uint32_t  delay 
)

Event on DHCP6 client transition to next state with random delay(Op)

Parameters
statenext state
delaystart delay (in 100ms ticks)
__STATIC_INLINE void EvrNetDHCP6_NoAddressAvailable ( uint32_t  state)

Event on DHCP6 client no address available status received (Op)

Parameters
statecurrent state
__STATIC_INLINE void EvrNetDHCP6_OfferTimerCheckFailed ( void  )

Event on DHCP6 client offer address timer check failed (Error)

__STATIC_INLINE void EvrNetDHCP6_ReceiveFrame ( uint32_t  length)

Event on DHCP6 client receive frame (Op)

Parameters
lengthmessage length
__STATIC_INLINE void EvrNetDHCP6_SendDhcpMessage ( uint8_t  msg_type)

Event on DHCP6 client send message (Op)

Parameters
msg_typemessage type
__STATIC_INLINE void EvrNetDHCP6_ServerNotChosen ( void  )

Event on DHCP6 client server not chosen in DISCOVER, REBIND state (Op)

Note
Silently discard the message.
__STATIC_INLINE void EvrNetDHCP6_ShowDnsServers ( const uint8_t *  dns_list)

Event on DHCP6 client display DNS server addresses (Op)

Parameters
dns_listpointer to DNS server address list
Note
Displays primary and secondary DNS server address.
__STATIC_INLINE void EvrNetDHCP6_ShowIanaOffer ( const void *  iana_offer)

Event on DHCP6 client display IANA offer (Op)

Parameters
iana_offerpointer to IANA structure
Note
IANA: Identity Association for non-temporary Address
__STATIC_INLINE void EvrNetDHCP6_ShowMessage ( uint8_t  msg_type,
uint32_t  xid 
)

Event on DHCP6 client display message information (Op)

Parameters
msg_typemessage type
xidtransaction identifier
Note
The size of transaction identifier (XID) is 3 bytes.
__STATIC_INLINE void EvrNetDHCP6_StartClient ( uint32_t  mode)

Event on DHCP6 client start (Op)

Parameters
modeclient mode
  • 0: Stateless mode
  • 1: Stateful mode
__STATIC_INLINE void EvrNetDHCP6_StateRetransmit ( uint32_t  state)

Event on DHCP6 client retransmit request in current state (Op)

Parameters
statecurrent state
__STATIC_INLINE void EvrNetDHCP6_StateTimeout ( uint32_t  state)

Event on DHCP6 client timeout in current state (Op)

Parameters
statecurrent state
__STATIC_INLINE void EvrNetDHCP6_StatusCode ( uint16_t  status)

Event on DHCP6 client option status code received (Op)

Parameters
statusstatus code
__STATIC_INLINE void EvrNetDHCP6_StopClient ( void  )

Event on DHCP6 client stop (Op)

__STATIC_INLINE void EvrNetDHCP6_T1Expired ( uint32_t  state)

Event on DHCP6 client timer T1 expired (Op)

Parameters
statecurrent state
__STATIC_INLINE void EvrNetDHCP6_T2Expired ( uint32_t  state)

Event on DHCP6 client timer T2 expired (Op)

Parameters
statecurrent state
__STATIC_INLINE void EvrNetDHCP6_UnknownMessageType ( uint8_t  msg_type)

Event on DHCP6 client unknown message type received (Error)

Parameters
msg_typemessage type
__STATIC_INLINE void EvrNetDHCP6_WrongClientId ( void  )

Event on DHCP6 client wrong client identifier received (Op)

Note
Silently discard the message.
__STATIC_INLINE void EvrNetDHCP6_WrongIaid ( uint32_t  iaid)

Event on DHCP6 client wrong Identity Association Identifier (IAID) received (Op)

Parameters
iaidwrong IAID value
__STATIC_INLINE void EvrNetDHCP6_WrongServerId ( void  )

Event on DHCP6 client wrong server identifier received (Op)

Note
Silently discard the message.
__STATIC_INLINE void EvrNetDHCP6_WrongTransactionId ( uint32_t  xid,
uint32_t  xid_valid 
)

Event on DHCP6 client wrong transaction identifier (XID) received (Error)

Parameters
xidtransaction identifier
xid_validexpected/valid transaction identifier
Note
The size of transaction identifier (XID) is 3 bytes.