M2MInterface Class Reference

Enum defining different kinds of binding modes handled for client operations.

Definition at line 68 of file m2minterface.h.

Enum defining different kinds of errors that can occur during various client operations.

Definition at line 48 of file m2minterface.h.

Enum defining different kinds of network stacks that can be used by mbed Client.

Definition at line 83 of file m2minterface.h.

Initiates bootstrapping of the client with the provided Bootstrap Server information.

NOTE: This API is not supported for developers!!

Parameters:

security_object

The security object that contains information required for successful bootstrapping of the client.

Implemented in M2MInterfaceImpl.

Cancels the ongoing bootstrapping operation of the client.

If the client has already successfully bootstrapped, this function deletes the existing bootstrap information from the client. NOTE: This API is not supported for developers!!

Implemented in M2MInterfaceImpl.

Initiates the registration of the provided Security object to the corresponding LWM2M server.

Parameters:

security_object	The security object that contains information required for registering to the LWM2M server. If the client wants to register to multiple LWM2M servers, it must call this function once for each of the LWM2M server objects separately.
object_list	Objects that contain information about the client attempting to register to the LWM2M server.

Implemented in M2MInterfaceImpl.

Sets the function callback that is called by mbed-client to provide an entropy source from an application to ensure strong entropy.

Parameters:

entropy_callback

A function pointer that is called by mbed-client while performing a secure handshake. Function signature, if using mbed-client-mbedtls, should be int (*mbedtls_entropy_f_source_ptr)(void *data, unsigned char *output, size_t len, size_t *olen);

Implemented in M2MInterfaceImpl.

Sets the network interface handler that is used by client to connect to a network over IP.

Parameters:

handler

A network interface handler that is used by client to connect. This API is optional but provides a mechanism for different platforms to manage usage of underlying network interface by client.

Implemented in M2MInterfaceImpl.

Sets the function that is called for indicating that the client is going to sleep when the Binding mode is selected with Queue mode.

Parameters:

callback

A function pointer that is called when the client goes to sleep.

Implemented in M2MInterfaceImpl.

Sets the function callback that is called by mbed-client to fetch a random number from an application to ensure strong entropy.

Parameters:

random_callback

A function pointer that is called by mbed-client while performing a secure handshake. The function signature should be uint32_t (*random_number_callback)(void);

Implemented in M2MInterfaceImpl.

Unregisters the registered object from the LWM2M server.

Parameters:

security_object

The security object from which the device object needs to be unregistered. If there is only one LWM2M server registered, this parameter can be NULL.

Implemented in M2MInterfaceImpl.

Updates or refreshes the client's registration on the LWM2M server.

Parameters:

security_object	The security object from which the device object needs to update the registration. If there is only one LWM2M server registered, this parameter can be NULL.
lifetime	The lifetime of the endpoint client in seconds. If the same value has to be passed, set the default value to 0.

Implemented in M2MInterfaceImpl.