Rtos API example

Embed: (wiki syntax)

« Back to documentation index

thread_net_config_api.h File Reference

thread_net_config_api.h File Reference

Public API to handle the Thread network services and configuration. More...

Go to the source code of this file.

Typedefs

typedef void thread_net_config_nd_data_req_cb (int8_t interface_id, int8_t status, uint8_t *data_ptr, uint16_t data_len)
 function callback type for nd_data_request.

Functions

int thread_net_config_nd_data_request (int8_t interface_id, const uint8_t destination[16], const uint8_t *options, uint8_t options_len, thread_net_config_nd_data_req_cb *callback)
 Request ND options (as in RFC6106) from given destination.

Detailed Description

Public API to handle the Thread network services and configuration.

Definition in file thread_net_config_api.h.


Typedef Documentation

typedef void thread_net_config_nd_data_req_cb(int8_t interface_id, int8_t status, uint8_t *data_ptr, uint16_t data_len)

function callback type for nd_data_request.

Parameters:
inteface_idNetwork interface ID where request was made.
status0 when response is received from destination, -1 otherwise.
data_ptrND_data options encoded according to RFC6106. Is NULL if destination was unreachable or didn't have the requested data.
data_lenLength of data in bytes.

Definition at line 37 of file thread_net_config_api.h.


Function Documentation

int thread_net_config_nd_data_request ( int8_t  interface_id,
const uint8_t  destination[16],
const uint8_t *  options,
uint8_t  options_len,
thread_net_config_nd_data_req_cb callback 
)

Request ND options (as in RFC6106) from given destination.

Response data will be provided in callback function.

Parameters:
interface_idnetwork interface ID.
destinationIPv6 address where request is sent.
optionsrequested option type identifiers according to RFC6106.
options_lennumber of options requested.
callbackFunction that will be called once information is available.
Returns:
0 on success. A callback will be called with/without response data.
<0 in error cases. Callback will not be called.