NebulaCommon.h File Reference

#include "NebulaError.h"
#include "TUTKJsonAPIs.h"
#include "NebulaJsonAPIs.h"
#include "TUTKGlobalAPIs.h"

Macros
#define	NEBULA_API   __declspec(dllimport)
#define	NEBULA_API_DEPRECATED
#define	MAX_PUBLIC_UDID_LENGTH   40
#define	MAX_PIN_CODE_LENGTH   9
#define	MAX_UDID_LENGTH   106
#define	MAX_NEBULA_PSK_LENGTH   1024
#define	MAX_NEBULA_IDENTITY_LENGTH   119
#define	MAX_NEBULA_SECRETID_LENGTH   128

Functions
NEBULA_API const char *	Nebula_Get_Version_String (void)
	Get the version of Nebula module.
NEBULA_API int	Nebula_Initialize ()
	Initialize Nebula module.
NEBULA_API int	Nebula_DeInitialize ()
	Deinitialize Nebula module.
NEBULA_API int	Nebula_Set_Log_Attr (LogAttr logAttr)
	Set Attribute of log file.

Detailed Description

This file describes common APIs of the Nebula module in IOTC platform.

Copyright

Copyright (c) 2010 by Throughtek Co., Ltd. All Rights Reserved.

Macro Definition Documentation

#define MAX_NEBULA_IDENTITY_LENGTH   119

#define MAX_NEBULA_PSK_LENGTH   1024

#define MAX_NEBULA_SECRETID_LENGTH   128

#define MAX_PIN_CODE_LENGTH   9

#define MAX_PUBLIC_UDID_LENGTH   40

#define MAX_UDID_LENGTH   106

#define NEBULA_API   __declspec(dllimport)

#define NEBULA_API_DEPRECATED

Function Documentation

NEBULA_API int Nebula_DeInitialize

(

)

Deinitialize Nebula module.

This function will deinitialize Nebula module and must be the last function to call for Nebula module This would release all the resource allocated in this module.

Returns

NEBULA_ER_NoERROR if deinitialize successfully

Error code if return value < 0

• NEBULA_ER_NOT_INITIALIZE The Nebula module is not initialized yet

See Also

Nebula_Initialize()

NEBULA_API const char* Nebula_Get_Version_String

(

void

)

Get the version of Nebula module.

This function returns the version of Nebula module.

NEBULA_API int Nebula_Initialize

(

)

Initialize Nebula module.

This function is used by devices to initialize Nebula module and shall be called before any Nebula module related function is invoked.

Returns

NEBULA_ER_NoERROR if initializing successfully

Error code if return value < 0

• NEBULA_ER_RESOURCE_ERROR Getting system resource fail

See Also

Nebula_DeInitialize()

Attention

This function must be the first function to call, and this call MUST have a corresponding call to Nebula_DeInitialize when the operation is complete.

NEBULA_API int Nebula_Set_Log_Attr

(

LogAttr

logAttr

)

Set Attribute of log file.

Parameters

logAttr

[in] See LogAttr

Returns

NEBULA_ER_NoERROR on success.

The value < 0

• NEBULA_ER_INVALID_ARG Invalid input argument.