Server

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

Summary

Functions
`otServerAddService(otInstance aInstance, const otServiceConfig aConfig)`	`otError` Add a service configuration to the local network data.
`otServerGetNetDataLocal(otInstance aInstance, bool aStable, uint8_t aData, uint8_t *aDataLength)`	`otError` Provides a full or stable copy of the local Thread Network Data.
`otServerGetNextService(otInstance aInstance, otNetworkDataIterator aIterator, otServiceConfig *aConfig)`	`otError` Gets the next service in the local Network Data.
`otServerRegister(otInstance *aInstance)`	`otError` Immediately register the local network data with the Leader.
`otServerRemoveService(otInstance aInstance, uint32_t aEnterpriseNumber, const uint8_t aServiceData, uint8_t aServiceDataLength)`	`otError` Remove a service configuration from the local network data.

Functions

otServerAddService

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

Add a service configuration to the local network data.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aConfig`	A pointer to the service configuration.

Return Values

`OT_ERROR_NONE`	Successfully added the configuration to the local network data.
`OT_ERROR_INVALID_ARGS`	One or more configuration parameters were invalid.
`OT_ERROR_NO_BUFS`	Not enough room is available to add the configuration to the local network data.

See also:
otServerRemoveService
otServerRegister

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.

Details

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.
`[in,out] aDataLength`	On entry, size of the data buffer pointed to by `aData`. On exit, number of copied bytes.

otServerGetNextService

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

Gets the next service in the local Network Data.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in,out] 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.

Return Values

`OT_ERROR_NONE`	Successfully found the next service.
`OT_ERROR_NOT_FOUND`	No subsequent service exists in the Thread Network Data.

otServerRegister

otError otServerRegister(
  otInstance *aInstance
)

Immediately register the local network data with the Leader.

Details

Parameters

[in] aInstance

A pointer to an OpenThread instance.

Return Values

OT_ERROR_NONE

Successfully queued a Server Data Request message for delivery.

See also:
otServerAddService
otServerRemoveService

otServerRemoveService

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

Remove a service configuration from the local network data.

Details

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.

Return Values

`OT_ERROR_NONE`	Successfully removed the configuration from the local network data.
`OT_ERROR_NOT_FOUND`	Could not find the Border Router entry.

See also:
otServerAddService
otServerRegister

Resources

OpenThread API Reference topics originate from the source code, available on GitHub. For more information, or to contribute to our documentation, refer to Resources.