File size: 5,376 Bytes
24b81cb |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 |
/** @file */
// -------------------------------------------------------------------------
// states, (result + error) codes
// defined in C++
enum ERestResultState
{
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,
};
// -------------------------------------------------------------------------
// options
// defined in C++
enum ERestOption
{
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
};
// -------------------------------------------------------------------------
// object to be used from script for result binding
//
// [Example:]
//
// RestCallback cbx1 = new RestCallback;
// RestContext ctx = GetRestApi().GetRestContext("http://somethingsomewhere.com/path/");
// ctx.GET(cbx1,"RequestPath?Argument=Something");
//
// Event are then called upon RestCallback()
//
class RestCallback : Managed
{
/**
\brief Called in case request failed (ERestResultState) - Note! May be called multiple times in case of (RetryCount > 1)
*/
void OnError( int errorCode )
{
// override this with your implementation
Print(" !!! OnError() ");
};
/**
\brief Called in case request timed out or handled improperly (no error, no success, no data)
*/
void OnTimeout()
{
// override this with your implementation
Print(" !!! OnTimeout() ");
};
/**
\brief Called when data arrived and/ or response processed successfully
*/
void OnSuccess( string data, int dataSize )
{
// override this with your implementation
Print(" !!! OnSuccess() size=" + dataSize );
if( dataSize > 0 )
Print(data); // !!! NOTE: Print() will not output string longer than 1024b, check your dataSize !!!
};
/**
\brief Called when data arrived and/ or file created successfully
*/
void OnFileCreated( string fileName, int dataSize )
{
// override this with your implementation
Print(" !!! OnFileCreated() file=" + fileName + " size=" + dataSize );
};
};
// -------------------------------------------------------------------------
// context API and request API
class RestContext
{
private void RestContext() {}
private void ~RestContext() {}
/**
\brief Processes GET request and returns result (ERestResultState) and/ or data (timeout, error) when finished
*/
proto native int GET( RestCallback cb, string request );
/**
\brief Processes GET request and returns data immediately (thread blocking operation!)
*/
proto native string GET_now( string request );
/**
\brief Processes GET request and returns result (ERestResultState) and/ or stores data int specified file (timeout, error) when finished
*/
proto native int FILE( RestCallback cb, string request, string filename );
/**
\brief Processes GET request and returns result (ERestResultState) and/ stores data int specified file immediately (thread blocking operation!)
*/
proto native int FILE_now( string request, string filename );
/**
\brief Pushes POST request and returns result (ERestResultState) and/ or data (timeout, error) when finished
*/
proto native int POST( RestCallback cb, string request, string data );
/**
\brief Processes POST request and returns data immediately (thread blocking operation!)
*/
proto native string POST_now( string request, string data );
/**
\brief Clear all pending requests and buffers
*/
proto native void reset();
/**
\brief Set Content-Type header (string)
default content type is "application/octet-stream"
but you can specify whatever you like, for example "application/json" "application/sql" "text/plain"
*/
proto native void SetHeader( string value );
};
// -------------------------------------------------------------------------
// RestApi core for context create/ access + debug features
class RestApi
{
private void RestApi() {}
private void ~RestApi() {}
/**
\brief Get new or existing context for http comm GetRestContext("www.server915.com/interface/")
*/
proto native RestContext GetRestContext( string serverURL );
/**
\brief Get count of registered contexes
*/
proto native int GetContextCount();
/**
\brief Enable debug output to console (disabled by default)
*/
proto native void EnableDebug( bool bEnable );
/**
\brief List of all currently active contexes and processed (pending) requests
*/
proto native void DebugList();
/**
\brief Set specific option (integer)
*/
proto native void SetOption( int option, int value );
};
// -------------------------------------------------------------------------
// RestApi create/ access methods out of Hive initialization
proto native RestApi CreateRestApi();
proto native void DestroyRestApi();
proto native RestApi GetRestApi();
|