Rtos API example

Embed: (wiki syntax)

« Back to documentation index

thread_dhcpv6_server.h File Reference

thread_dhcpv6_server.h File Reference

Thread specific DHCP server. More...

Go to the source code of this file.

Functions

int thread_dhcpv6_server_add (int8_t interface_id, uint8_t *prefix_ptr, uint16_t max_client_cnt, bool stableData)
 Set DHCPV6 server for Thread GP data purpose.
int thread_dhcpv6_server_set_lifetime (int8_t interface_id, uint8_t *prefix_ptr, uint32_t valid_lifetime)
 Modify dhcp address valid lifetime values default value is 1 day (86400)
int thread_dhcpv6_server_set_max_client (int8_t interface_id, uint8_t *prefix_ptr, uint32_t max_client_count)
 Modify dhcp maximum client count.
int thread_dhcpv6_server_set_anonymous_addressing (int8_t interface_id, uint8_t *prefix_ptr, bool anonymous)
 Modify dhcp anonymous mode.
int thread_dhcpv6_server_delete (int8_t interface_id, uint8_t *prefix_ptr)
 Stop DHCPV6 server for Thread GP data purpose.

Detailed Description

Thread specific DHCP server.

Warning:
This api will be removed as there is no Thread specific modifications anymore.

Definition in file thread_dhcpv6_server.h.


Function Documentation

int thread_dhcpv6_server_add ( int8_t  interface_id,
uint8_t *  prefix_ptr,
uint16_t  max_client_cnt,
bool  stableData 
)

Set DHCPV6 server for Thread GP data purpose.

Parameters:
interface_idNetwork Interface
prefix_ptrpointer DHCPv6 Server Given Prefix
max_client_cntMax number of clients
stableDataTrue if data is stable
Returns:
0, Set OK
<0 Set Not OK
int thread_dhcpv6_server_delete ( int8_t  interface_id,
uint8_t *  prefix_ptr 
)

Stop DHCPV6 server for Thread GP data purpose.

Parameters:
interface_idNetwork Interface
prefix_ptrpointer DHCPv6 Server Given Prefix
Returns:
0, Stop OK
<0 Stop Not OK
int thread_dhcpv6_server_set_anonymous_addressing ( int8_t  interface_id,
uint8_t *  prefix_ptr,
bool  anonymous 
)

Modify dhcp anonymous mode.

Parameters:
interface_idNetwork Interface
prefix_ptrpointer DHCPv6 Server Given Prefix (size must be 16 bytes)
anonymoustrue == addressing mode is anonymous, false == addressing mode uses mac address after prefix.
Returns:
0, ADD OK
<0 Add Not OK
int thread_dhcpv6_server_set_lifetime ( int8_t  interface_id,
uint8_t *  prefix_ptr,
uint32_t  valid_lifetime 
)

Modify dhcp address valid lifetime values default value is 1 day (86400)

Parameters:
interface_idNetwork Interface
prefix_ptrpointer DHCPv6 Server Given Prefix (size must be 16 bytes)
valid_lifetimeNew valid life value given to new address valid values are (120 - 0xffffffff)
Returns:
0, ADD OK
<0 Add Not OK
int thread_dhcpv6_server_set_max_client ( int8_t  interface_id,
uint8_t *  prefix_ptr,
uint32_t  max_client_count 
)

Modify dhcp maximum client count.

Parameters:
interface_idNetwork Interface
prefix_ptrpointer DHCPv6 Server Given Prefix (size must be 16 bytes)
max_client_countmaximum amount of clients valid values (1 - 0xffffffff)
Returns:
0, ADD OK
<0 Add Not OK