fwRPC
 All Files Functions Variables
fwRPC_requestModel.ctl File Reference

Functions

dyn_mixed fwRPC_requestModel_new (string id, mixed params="", string func="", int status=fwRPC_REQUEST_STATUS_NONE, int threadid=-1, string worker="-1", string retval=fwRPC_REQUEST_INVALID_RETVAL, bool autoAck=false)
 
int fwRPC_requestModel_reset (dyn_mixed &request)
 
bool fwRPC_requestModel_hasTerminated (dyn_mixed request)
 
string fwRPC_requestModel_status_toString (int status)
 

Variables

const int fwRPC_REQUEST_STATUS_NONE = 1
 
const int fwRPC_REQUEST_STATUS_READY = 2
 
const int fwRPC_REQUEST_STATUS_QUEUED = 3
 
const int fwRPC_REQUEST_STATUS_ASSIGNED = 4
 
const int fwRPC_REQUEST_STATUS_PROCESSING = 5
 
const int fwRPC_REQUEST_STATUS_DONE = 6
 
const int fwRPC_REQUEST_STATUS_ACKED = 7
 
const int fwRPC_REQUEST_STATUS_ERROR = 8
 
const int fwRPC_REQUEST_STATUS_CANCEL = 9
 
const int fwRPC_REQUEST_STATUS_TIMEOUT = 10
 
const int fwRPC_REQUEST_MODEL_ID = 1
 
const int fwRPC_REQUEST_MODEL_FUNCTION = 2
 
const int fwRPC_REQUEST_MODEL_PARAMS = 3
 
const int fwRPC_REQUEST_MODEL_RETVAL = 4
 
const int fwRPC_REQUEST_MODEL_STATUS = 5
 
const int fwRPC_REQUEST_MODEL_THREADID = 6
 
const int fwRPC_REQUEST_MODEL_WORKER = 7
 
const int fwRPC_REQUEST_MODEL_EXPIRETIME = 8
 
const int fwRPC_REQUEST_MODEL_AUTOACK = 9
 
const int fwRPC_REQUEST_MODEL_MAXIDX = 10
 
const string fwRPC_REQUEST_INVALID_RETVAL = "__fwRPC#This^is_not!valid*return{value}?546546"
 

Detailed Description

This library contains constants for functionality for requests, includig DP, query, and model information. Also includes functionality for model initialization and synchronization.

Author
Victor Rodrigues (CERN, BE-ICS-SDS)

Function Documentation

bool fwRPC_requestModel_hasTerminated ( dyn_mixed  request)

Return whether or not the request is in a terminated state, i.e, one of the following states:

  • ACKED
  • DONE
  • ERROR
Parameters
request(IN, dyn_mixed) request object
Returns
true if terminated false otherwise
Exceptions
nothing
dyn_mixed fwRPC_requestModel_new ( string  id,
mixed  params = "",
string  func = "",
int  status = fwRPC_REQUEST_STATUS_NONE,
int  threadid = -1,
string  worker = "-1",
string  retval = fwRPC_REQUEST_INVALID_RETVAL,
bool  autoAck = false 
)

Construct a new request object

Parameters
id(IN, string) Reqeust ID
params(IN, mixed) Initial params
function(IN, string) Function name
status(IN, int) Initial status
threadid(IN, int) Initial executing thread id
worker(IN, string) Initial assigned worker id
retval(IN, string) Serialized result value
Returns
request object
Exceptions
nothing
int fwRPC_requestModel_reset ( dyn_mixed &  request)

Reset a given request if it has not already been completed.

Parameters
request(IN|OUT, dyn_mixed) request to reset
Returns
0 on success -1 if the request was already completed
Exceptions
nothing
string fwRPC_requestModel_status_toString ( int  status)

Return the string representation of a status value

status (IN, int) status

Returns
string representation of status nul string if status is invalid
Exceptions
nothing

Variable Documentation

const string fwRPC_REQUEST_INVALID_RETVAL = "__fwRPC#This^is_not!valid*return{value}?546546"

Request model - invalid value

const int fwRPC_REQUEST_MODEL_AUTOACK = 9

Request model indexes

const int fwRPC_REQUEST_MODEL_EXPIRETIME = 8

Request model indexes

const int fwRPC_REQUEST_MODEL_FUNCTION = 2

Request model indexes

const int fwRPC_REQUEST_MODEL_ID = 1

Request model indexes

const int fwRPC_REQUEST_MODEL_MAXIDX = 10

Request model indexes

const int fwRPC_REQUEST_MODEL_PARAMS = 3

Request model indexes

const int fwRPC_REQUEST_MODEL_RETVAL = 4

Request model indexes

const int fwRPC_REQUEST_MODEL_STATUS = 5

Request model indexes

const int fwRPC_REQUEST_MODEL_THREADID = 6

Request model indexes

const int fwRPC_REQUEST_MODEL_WORKER = 7

Request model indexes

const int fwRPC_REQUEST_STATUS_ACKED = 7

Possible fwRPC request states

const int fwRPC_REQUEST_STATUS_ASSIGNED = 4

Possible fwRPC request states

const int fwRPC_REQUEST_STATUS_CANCEL = 9

Possible fwRPC request states

const int fwRPC_REQUEST_STATUS_DONE = 6

Possible fwRPC request states

const int fwRPC_REQUEST_STATUS_ERROR = 8

Possible fwRPC request states

const int fwRPC_REQUEST_STATUS_NONE = 1

Possible fwRPC request states

const int fwRPC_REQUEST_STATUS_PROCESSING = 5

Possible fwRPC request states

const int fwRPC_REQUEST_STATUS_QUEUED = 3

Possible fwRPC request states

const int fwRPC_REQUEST_STATUS_READY = 2

Possible fwRPC request states

const int fwRPC_REQUEST_STATUS_TIMEOUT = 10

Possible fwRPC request states