Tizen RT Public API  v1.1 D4
LWM2M

Provides APIs for LWM2M Client. More...

Collaboration diagram for LWM2M:

Files

file  dm_lwm2m.h
 device management APIs for DM
 

Data Structures

struct  server_info_s
 Specify LWM2M server information such as ipaddress and port. More...
 
struct  client_info_s
 Specify LWM2M client information such as session lifetime. More...
 
struct  dm_lwm2m_context_s
 Specify DM context structure for a LWM2M session. More...
 

Enumerations

enum  dm_lwm2m_client_state_e
 Enumeration of dm client state. More...
 

Functions

int dm_lwm2m_start_client (struct dm_lwm2m_context_s *dm_context)
 Start a DM client. More...
 
int dm_lwm2m_stop_client (void)
 Close a DM client. More...
 
int dm_lwm2m_get_server_address (char *server_ipAddr)
 Get server IP address. More...
 
int dm_lwm2m_get_server_port (char *server_port)
 Get server port number. More...
 
int dm_lwm2m_get_client_lifetime (int *lifetime)
 Get lifetime for a client. More...
 
int dm_lwm2m_get_client_state (dm_lwm2m_client_state_e *state)
 Get state of client. More...
 
int dm_lwm2m_display_client_resource (char *buffer)
 Get client resource value. More...
 

Detailed Description

Provides APIs for LWM2M Client.

Enumeration Type Documentation

◆ dm_lwm2m_client_state_e

Enumeration of dm client state.

Enumeration Details:
DM_LWM2M_CLIENT_STARTED
DM_LWM2M_CLIENT_STOPPED

Definition at line 53 of file dm_lwm2m.h.

Function Documentation

◆ dm_lwm2m_display_client_resource()

int dm_lwm2m_display_client_resource ( char *  buffer)

Get client resource value.

#include <dm/dm_lwm2m.h>

Parameters
[in]bufferpointer to resource URI
Returns
On success, 0 is returned. On failure, a negative value is returned.
Since
Tizen RT v1.0

◆ dm_lwm2m_get_client_lifetime()

int dm_lwm2m_get_client_lifetime ( int *  lifetime)

Get lifetime for a client.

#include <dm/dm_lwm2m.h>

Parameters
[out]lifetimepointer to memory to store client lifetime
Returns
On success, 0 is returned. On failure, a negative value is returned.
Since
Tizen RT v1.0

◆ dm_lwm2m_get_client_state()

int dm_lwm2m_get_client_state ( dm_lwm2m_client_state_e state)

Get state of client.

#include <dm/dm_lwm2m.h>

Parameters
[out]statepointer to memory to store client state
Returns
On success, 0 is returned. On failure, a negative value is returned.
Since
Tizen RT v1.0

◆ dm_lwm2m_get_server_address()

int dm_lwm2m_get_server_address ( char *  server_ipAddr)

Get server IP address.

#include <dm/dm_lwm2m.h>

Parameters
[out]server_ipAddrpointer to memory to store server IP address
Returns
On success, 0 is returned. On failure, a negative value is returned.
Since
Tizen RT v1.0

◆ dm_lwm2m_get_server_port()

int dm_lwm2m_get_server_port ( char *  server_port)

Get server port number.

#include <dm/dm_lwm2m.h>

Parameters
[out]server_portpointer to memory to store server port
Returns
On success, 0 is returned. On failure, a negative value is returned.
Since
Tizen RT v1.0

◆ dm_lwm2m_start_client()

int dm_lwm2m_start_client ( struct dm_lwm2m_context_s dm_context)

Start a DM client.

#include <dm/dm_lwm2m.h>

Parameters
[in]dm_contextpointer to DM context
Returns
On success, 0 is returned. On failure, a negative value is returned. If client is already started, return DM_ERROR_ALREADY_STARTED.
Since
Tizen RT v1.0

◆ dm_lwm2m_stop_client()

int dm_lwm2m_stop_client ( void  )

Close a DM client.

#include <dm/dm_lwm2m.h>

Returns
On success, 0 is returned. On failure, a negative value is returned. If client is already stopped, return DM_ERROR_ALREADY_STOPPED.
Since
Tizen RT v1.0