Server#

This module includes functions to manage local network data with the OpenThread Server.

Functions#

otError
otServerGetNetDataLocal(otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)

Provides a full or stable copy of the local Thread Network Data.

otError
otServerAddService(otInstance *aInstance, const otServiceConfig *aConfig)

Add a service configuration to the local network data.

otError
otServerRemoveService(otInstance *aInstance, uint32_t aEnterpriseNumber, const uint8_t *aServiceData, uint8_t aServiceDataLength)

Remove a service configuration from the local network data.

otError
otServerGetNextService(otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig)

Gets the next service in the local Network Data.

otError
otServerRegister(otInstance *aInstance)

Immediately register the local network data with the Leader.

Function Documentation#

otServerGetNetDataLocal#

otError otServerGetNetDataLocal (otInstance * aInstance, bool aStable, uint8_t * aData, uint8_t * aDataLength)

Provides a full or stable copy of the local Thread Network Data.

Parameters
[in]aInstance

A pointer to an OpenThread instance.

[in]aStable

TRUE when copying the stable version, FALSE when copying the full version.

[out]aData

A pointer to the data buffer.

[inout]aDataLength

On entry, size of the data buffer pointed to by aData. On exit, number of copied bytes.


Definition at line 62 of file include/openthread/server.h

otServerAddService#

otError otServerAddService (otInstance * aInstance, const otServiceConfig * aConfig)

Add a service configuration to the local network data.

Parameters
[in]aInstance

A pointer to an OpenThread instance.

[in]aConfig

A pointer to the service configuration.

See Also


Definition at line 77 of file include/openthread/server.h

otServerRemoveService#

otError otServerRemoveService (otInstance * aInstance, uint32_t aEnterpriseNumber, const uint8_t * aServiceData, uint8_t aServiceDataLength)

Remove a service configuration from the local network data.

Parameters
[in]aInstance

A pointer to an OpenThread instance.

[in]aEnterpriseNumber

Enterprise Number of the service entry to be deleted.

[in]aServiceData

A pointer to an Service Data to look for during deletion.

[in]aServiceDataLength

The length of aServiceData in bytes.

See Also


Definition at line 93 of file include/openthread/server.h

otServerGetNextService#

otError otServerGetNextService (otInstance * aInstance, otNetworkDataIterator * aIterator, otServiceConfig * aConfig)

Gets the next service in the local Network Data.

Parameters
[in]aInstance

A pointer to an OpenThread instance.

[inout]aIterator

A pointer to the Network Data iterator context. To get the first service entry it should be set to OT_NETWORK_DATA_ITERATOR_INIT.

[out]aConfig

A pointer to where the service information will be placed.


Definition at line 109 of file include/openthread/server.h

otServerRegister#

otError otServerRegister (otInstance * aInstance)

Immediately register the local network data with the Leader.

Parameters
[in]aInstance

A pointer to an OpenThread instance.

See Also


Definition at line 121 of file include/openthread/server.h