types.h File Reference

Provides definitions for types and enums used by Awa LWM2M API and Static API. More...

#include "error.h"

Include dependency graph for types.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	AwaOpaque
	A utility struct used to convey data pointer and size of an opaque data block. More...
struct	AwaObjectLink
	A utility struct used to convey object link data. More...

Macros
#define	AWA_INVALID_ID
	Used to mark an invalid object, object instance or resource ID. More...
#define	AWA_MAX_ID
	Defines the maximum permissible object, object instance or resource ID. More...

Typedefs
typedef int	AwaObjectID
typedef int	AwaObjectInstanceID
typedef int	AwaResourceID
typedef int	AwaResourceInstanceID
typedef int64_t	AwaInteger
	Corresponds to the LWM2M 64-bit Integer type. More...
typedef double	AwaFloat
	Corresponds to the LWM2M Float type. More...
typedef bool	AwaBoolean
	Corresponds to the LWM2M Boolean type. More...
typedef int64_t	AwaTime
	Corresponds to the LWM2M Time type. More...
typedef struct AwaOpaque	AwaOpaque
	A utility struct used to convey data pointer and size of an opaque data block. More...
typedef struct AwaObjectLink	AwaObjectLink
	A utility struct used to convey object link data. More...

Enumerations
enum	AwaResourceType {   AwaResourceType_Invalid,   AwaResourceType_None,   AwaResourceType_String,   AwaResourceType_Integer,   AwaResourceType_Float,   AwaResourceType_Boolean,   AwaResourceType_Opaque,   AwaResourceType_Time,   AwaResourceType_ObjectLink,   AwaResourceType_StringArray,   AwaResourceType_IntegerArray,   AwaResourceType_FloatArray,   AwaResourceType_BooleanArray,   AwaResourceType_OpaqueArray,   AwaResourceType_TimeArray,   AwaResourceType_ObjectLinkArray,   AwaResourceType_LAST,   AwaResourceType_FirstArrayType,   AwaResourceType_LastArrayType }
	Supported resource types. More...
enum	AwaResourceOperations {   AwaResourceOperations_Invalid,   AwaResourceOperations_None,   AwaResourceOperations_ReadOnly,   AwaResourceOperations_WriteOnly,   AwaResourceOperations_ReadWrite,   AwaResourceOperations_Execute,   AwaResourceOperations_LAST }
	Supported resource operations for management servers. More...
enum	AwaLogLevel {   AwaLogLevel_None,   AwaLogLevel_Error,   AwaLogLevel_Warning,   AwaLogLevel_Verbose,   AwaLogLevel_Debug }
	Supported log levels for a log command. More...
enum	AwaCertificateFormat {   AwaCertificateFormat_None,   AwaCertificateFormat_ASN1,   AwaCertificateFormat_PEM }
	Supported Certificate formats. More...
enum	AwaContentType {   AwaContentType_None,   AwaContentType_ApplicationPlainText,   AwaContentType_ApplicationLinkFormat,   AwaContentType_ApplicationOctetStream,   AwaContentType_ApplicationJson,   AwaContentType_ApplicationOmaLwm2mText,   AwaContentType_ApplicationOmaLwm2mTLV_Old,   AwaContentType_ApplicationOmaLwm2mJson_Old,   AwaContentType_ApplicationOmaLwm2mOpaque,   AwaContentType_ApplicationOmaLwm2mTLV,   AwaContentType_ApplicationOmaLwm2mJson }
enum	AwaClientRegistrationStatus {   AwaClientRegistrationStatus_Invalid,   AwaClientRegistrationStatus_Bootstrap,   AwaClientRegistrationStatus_BootstrapFailed,   AwaClientRegistrationStatus_NotRegistered,   AwaClientRegistrationStatus_Registering,   AwaClientRegistrationStatus_Registered,   AwaClientRegistrationStatus_RegisterFailed }

Detailed Description

Provides definitions for types and enums used by Awa LWM2M API and Static API.

Macro Definition Documentation

#define AWA_INVALID_ID

Used to mark an invalid object, object instance or resource ID.

#define AWA_MAX_ID

Defines the maximum permissible object, object instance or resource ID.

Examples:

client-defineset-example.c, and server-defineset-example.c.

Typedef Documentation

typedef int AwaObjectID

typedef int AwaObjectInstanceID

typedef int AwaResourceID

typedef int AwaResourceInstanceID

typedef int64_t AwaInteger

Corresponds to the LWM2M 64-bit Integer type.

typedef double AwaFloat

Corresponds to the LWM2M Float type.

typedef bool AwaBoolean

Corresponds to the LWM2M Boolean type.

typedef int64_t AwaTime

Corresponds to the LWM2M Time type.

typedef struct AwaOpaque AwaOpaque

A utility struct used to convey data pointer and size of an opaque data block.

typedef struct AwaObjectLink AwaObjectLink

A utility struct used to convey object link data.

Enumeration Type Documentation

enum AwaResourceType

Supported resource types.

Enumerator
AwaResourceType_Invalid	indicates an invalid resource type
AwaResourceType_None	indicates a resource with no type
AwaResourceType_String	indicates a resource capable of holding an ASCII string (UTF-8 is not supported)
AwaResourceType_Integer	indicates a resource capable of holding a LWM2M Integer value
AwaResourceType_Float	indicates a resource capable of holding a LWM2M Float value
AwaResourceType_Boolean	indicates a resource capable of holding a LWM2M Boolean value
AwaResourceType_Opaque	indicates a resource capable of holding a LWM2M Opaque value
AwaResourceType_Time	indicates a resource capable of holding a LWM2M Time value
AwaResourceType_ObjectLink	indicates a resource capable of holding a LWM2M ObjectLink value
AwaResourceType_StringArray	indicates a multiple-instance resource capable of holding a number of ASCII string values
AwaResourceType_IntegerArray	indicates a multiple-instance resource capable of holding a number of LWM2M Integer values
AwaResourceType_FloatArray	indicates a multiple-instance resource capable of holding a number of LWM2M Float values
AwaResourceType_BooleanArray	indicates a multiple-instance resource capable of holding a number of LWM2M Boolean values
AwaResourceType_OpaqueArray	indicates a multiple-instance resource capable of holding a number of LWM2M Opaque values
AwaResourceType_TimeArray	indicates a multiple-instance resource capable of holding a number of LWM2M Time values
AwaResourceType_ObjectLinkArray	indicates a multiple-instance resource capable of holding a number of LWM2M ObjectLink values
AwaResourceType_LAST	Reserved value.
AwaResourceType_FirstArrayType	Reserved value.
AwaResourceType_LastArrayType	Reserved value.

enum AwaResourceOperations

Supported resource operations for management servers.

Enumerator
AwaResourceOperations_Invalid	indicates an invalid resource operation
AwaResourceOperations_None	indicates no operations are permitted to a management server
AwaResourceOperations_ReadOnly	indicates the resource is read-only to a management server
AwaResourceOperations_WriteOnly	indicates the resource is write-only to a management server
AwaResourceOperations_ReadWrite	indicates the resource can be read and written by a management server
AwaResourceOperations_Execute	indicates the resource can be executed by a management server
AwaResourceOperations_LAST	Reserved value.

enum AwaLogLevel

Supported log levels for a log command.

Enumerator
AwaLogLevel_None	No log information is reported.
AwaLogLevel_Error	Only errors are reported.
AwaLogLevel_Warning	Warnings are reported, in addition to Error.
AwaLogLevel_Verbose	High-level information is reported, in addition to Warning.
AwaLogLevel_Debug	Low-level information is reported, in addition to Verbose.

enum AwaCertificateFormat

Supported Certificate formats.

Enumerator
AwaCertificateFormat_None	Not set.
AwaCertificateFormat_ASN1	Raw ASN1 sequence.
AwaCertificateFormat_PEM	PEM format.

enum AwaContentType

Enumerator
AwaContentType_None
AwaContentType_ApplicationPlainText
AwaContentType_ApplicationLinkFormat
AwaContentType_ApplicationOctetStream
AwaContentType_ApplicationJson
AwaContentType_ApplicationOmaLwm2mText
AwaContentType_ApplicationOmaLwm2mTLV_Old
AwaContentType_ApplicationOmaLwm2mJson_Old
AwaContentType_ApplicationOmaLwm2mOpaque
AwaContentType_ApplicationOmaLwm2mTLV
AwaContentType_ApplicationOmaLwm2mJson

enum AwaClientRegistrationStatus

Enumerator
AwaClientRegistrationStatus_Invalid	invalid client reference
AwaClientRegistrationStatus_Bootstrap	bootstrap in progress
AwaClientRegistrationStatus_BootstrapFailed	bootstrap failed
AwaClientRegistrationStatus_NotRegistered	not registered (to any server)
AwaClientRegistrationStatus_Registering	register in progress (and not registered or failed on another server)
AwaClientRegistrationStatus_Registered	register complete (to at least one server)
AwaClientRegistrationStatus_RegisterFailed	register failed (and not registered on another server)