RestApi.c File Reference

Go to the source code of this file.

Classes
class	RestCallback
class	RestContext
class	RestApi

Enumerations
enum	ERestResultState {   EREST_EMPTY , EREST_PENDING , EREST_FEEDING , EREST_SUCCESS ,   EREST_PROCESSED , EREST_ERROR , EREST_ERROR_CLIENTERROR , EREST_ERROR_SERVERERROR ,   EREST_ERROR_APPERROR , EREST_ERROR_TIMEOUT , EREST_ERROR_NOTIMPLEMENTED , EREST_ERROR_UNKNOWN }
enum	ERestOption { ERESTOPTION_UNKNOWN , ERESTOPTION_READOPERATION , ERESTOPTION_CONNECTION }

Functions
proto native RestApi	CreateRestApi ()
proto native void	DestroyRestApi ()
proto native RestApi	GetRestApi ()

Enumeration Type Documentation

ERestOption

enum ERestOption

Enumerator
ERESTOPTION_UNKNOWN
ERESTOPTION_READOPERATION
ERESTOPTION_CONNECTION

Definition at line 28 of file RestApi.c.

{
  ERESTOPTION_UNKNOWN, // invalid option
 
  ERESTOPTION_READOPERATION, // read operation timeout (default 10sec)
  ERESTOPTION_CONNECTION, // connection timeout (default 10sec)
  // note: limit for timeout is between <3 .. 120> seconds, you cannot exceed this value
};

ERestResultState

enum ERestResultState

Enumerator
EREST_EMPTY
EREST_PENDING
EREST_FEEDING
EREST_SUCCESS
EREST_PROCESSED
EREST_ERROR
EREST_ERROR_CLIENTERROR
EREST_ERROR_SERVERERROR
EREST_ERROR_APPERROR
EREST_ERROR_TIMEOUT
EREST_ERROR_NOTIMPLEMENTED
EREST_ERROR_UNKNOWN

Definition at line 8 of file RestApi.c.

{
  EREST_EMPTY, // not initialized
  EREST_PENDING, // awaiting processing
  EREST_FEEDING, // awaiting incoming data
  EREST_SUCCESS, // result and/ or data are ready (success), awaiting data processing to be finished (no longer blocking queue processing)
  EREST_PROCESSED, // finished (either successfully or with failure) and eill be removed ASAP
 
  EREST_ERROR, // (state >= EREST_ERROR) == error happened
  EREST_ERROR_CLIENTERROR, // (EREST_ERROR == EREST_ERROR_CLIENTERROR)
  EREST_ERROR_SERVERERROR,
  EREST_ERROR_APPERROR,
  EREST_ERROR_TIMEOUT,
  EREST_ERROR_NOTIMPLEMENTED,
  EREST_ERROR_UNKNOWN,
};

Function Documentation

CreateRestApi()

proto native RestApi CreateRestApi

(

)

DestroyRestApi()

proto native void DestroyRestApi

(

)

GetRestApi()

proto native RestApi GetRestApi

(

)