joey shelton / LED_Demo

Dependencies:   MAX44000 PWM_Tone_Library nexpaq_mdk

Fork of LED_Demo by Maxim nexpaq

Embed: (wiki syntax)

« Back to documentation index

M2MInterfaceFactory Class Reference

M2MInterfaceFactory Class Reference

M2MInterfaceFactory. More...

#include <m2minterfacefactory.h>

Static Public Member Functions

static M2MInterfacecreate_interface (M2MInterfaceObserver &observer, const String &endpoint_name, const String &endpoint_type="", const int32_t life_time=-1, const uint16_t listen_port=5683, const String &domain="", M2MInterface::BindingMode mode=M2MInterface::NOT_SET, M2MInterface::NetworkStack stack=M2MInterface::LwIP_IPv4, const String &context_address="")
 Creates an interface object for the mbed Client Inteface.
static M2MSecuritycreate_security (M2MSecurity::ServerType server_type)
 Creates a security object for the mbed Client Inteface.
static M2MServercreate_server ()
 Creates a server object for the mbed Client Inteface.
static M2MDevicecreate_device ()
 Creates a device object for the mbed Client Inteface.
static M2MFirmwarecreate_firmware ()
 Creates a firmware object for the mbed Client Inteface.
static M2MObjectcreate_object (const String &name)
 Creates a generic object for the mbed Client Inteface.

Detailed Description

M2MInterfaceFactory.

This is a factory class that provides an interface for creating an mbed Client Interface object for an application to utilize the LWM2M features provided by the client.

Definition at line 36 of file m2minterfacefactory.h.


Member Function Documentation

M2MDevice * create_device (  ) [static]

Creates a device object for the mbed Client Inteface.

With this, the client can manage the device resources used for client operations such as Client Registration, Device Management and Information Reporting.

Parameters:
nameThe name of the device object.
Returns:
M2MDevice An object for managing other client operations.

Definition at line 90 of file m2minterfacefactory.cpp.

M2MFirmware * create_firmware (  ) [static]

Creates a firmware object for the mbed Client Inteface.

With this, the client can manage the firmware resources used for the client operations such as Client Registration, Device Management and Information Reporting.

Returns:
M2MFirmware An object for managing other client operations.

Definition at line 97 of file m2minterfacefactory.cpp.

M2MInterface * create_interface ( M2MInterfaceObserver observer,
const String &  endpoint_name,
const String &  endpoint_type = "",
const int32_t  life_time = -1,
const uint16_t  listen_port = 5683,
const String &  domain = "",
M2MInterface::BindingMode  mode = M2MInterface::NOT_SET,
M2MInterface::NetworkStack  stack = M2MInterface::LwIP_IPv4,
const String &  context_address = "" 
) [static]

Creates an interface object for the mbed Client Inteface.

With this, the client can handle client operations like Bootstrapping, Client Registration, Device Management and Information Reporting.

Parameters:
endpoint_nameThe endpoint name of the mbed client.
endpoint_typeThe endpoint type of the mbed client, default is empty.
life_timeThe lifetime of the endpoint in seconds, if -1 it is optional.
listen_portThe listening port for the endpoint, default is 5683.
domainThe domain of the endpoint, default is empty.
modeThe binding mode of the endpoint, default is NOT_SET.
stackThe underlying network stack to be used for the connection, default is LwIP_IPv4.
context_addressThe context address for M2M-HTTP, not used currently.
Returns:
M2MInterfaceImpl An object for managing other client operations.

Definition at line 28 of file m2minterfacefactory.cpp.

M2MObject * create_object ( const String &  name ) [static]

Creates a generic object for the mbed Client Inteface.

With this, the client can manage its own customized resources used for registering Device Management and Information Reporting for those resources.

Parameters:
nameThe name of the object.
idA unique ID for the object. It should be other than the reserved LWM2M object IDs.
Returns:
M2MObject An object for managing other mbed Client operations.

Definition at line 104 of file m2minterfacefactory.cpp.

M2MSecurity * create_security ( M2MSecurity::ServerType  server_type ) [static]

Creates a security object for the mbed Client Inteface.

With this, the client can manage Bootstrapping and Client Registration.

Parameters:
ServerTypeThe type of the Security Object, bootstrap or LWM2M server.
Returns:
M2MSecurity An object for managing other client operations.

Definition at line 76 of file m2minterfacefactory.cpp.

M2MServer * create_server (  ) [static]

Creates a server object for the mbed Client Inteface.

With this, the client can manage the server resources used for client operations such as Client Registration, server lifetime etc.

Returns:
M2MServer An object for managing server client operations.

Definition at line 83 of file m2minterfacefactory.cpp.