JSON-RPC Functions

Classes
class	MJSO

Typedefs
typedef MJsonNode *()	mjsonrpc_handler_t(const MJsonNode *params)

Functions
void	mjsonrpc_init ()
void	mjsonrpc_user_init ()
void	mjsonrpc_add_handler (const char *method, mjsonrpc_handler_t *handler, bool needs_locking=false)
void	mjsonrpc_exit ()
void	mjsonrpc_set_std_mutex (void *mutex)
MJsonNode *	mjsonrpc_get_schema ()
std::string	mjsonrpc_schema_to_text (const MJsonNode *schema)
MJsonNode *	mjsonrpc_make_error (int code, const char *message, const char *data)
MJsonNode *	mjsonrpc_make_result (MJsonNode *node)
MJsonNode *	mjsonrpc_make_result (const char *name, MJsonNode *value, const char *name2=NULL, MJsonNode *value2=NULL, const char *name3=NULL, MJsonNode *value3=NULL)
const MJsonNode *	mjsonrpc_get_param (const MJsonNode *params, const char *name, MJsonNode **error)
MJsonNode *	mjsonrpc_decode_post_data (const char *post_data)
static MJSO *	MJSO::MakeObjectSchema (const char *description)
static MJSO *	MJSO::MakeArraySchema (const char *description)
void	MJSO::AddToSchema (MJsonNode *s, const char *name)
static MJSO *	MJSO::I ()
void	MJSO::D (const char *description)
MJSO *	MJSO::Params ()
MJSO *	MJSO::Result ()
MJSO *	MJSO::PA (const char *description)
MJSO *	MJSO::RA (const char *description)
void	MJSO::P (const char *name, int mjson_type, const char *description)
void	MJSO::R (const char *name, int mjson_type, const char *description)
void	MJSO::Add (const char *name, int mjson_type, const char *description)
MJSO *	MJSO::AddObject (const char *name, const char *description)
MJSO *	MJSO::AddArray (const char *name, const char *description)
	MJSO::MJSO ()

Variables
int	mjsonrpc_debug
MJsonNode *	MJSO::properties
MJsonNode *	MJSO::required
MJsonNode *	MJSO::items
MJSO *	MJSO::params
MJSO *	MJSO::result

Detailed Description

Typedef Documentation

mjsonrpc_handler_t

typedef MJsonNode*() mjsonrpc_handler_t(const MJsonNode *params)

Definition at line 18 of file mjsonrpc.h.

Function Documentation

MJSO()

MJSO::MJSO ( )

protected

Definition at line 402 of file mjsonrpc.cxx.

   : MJsonNode(MJSON_OBJECT)
{
   properties = NULL;
   required = NULL;
   items = NULL;
   params = NULL;
   result = NULL;
}

Here is the caller graph for this function:

Add()

void MJSO::Add	(	const char *	name,
		int	mjson_type,
		const char *	description
	)

Definition at line 355 of file mjsonrpc.cxx.

{
   MJsonNode* p = MJsonNode::MakeObject();
   p->AddToObject("description", MJsonNode::MakeString(description));
   if (mjson_type == MJSON_ARRAY)
      p->AddToObject("type", MJsonNode::MakeString("array"));
   else if (mjson_type == MJSON_OBJECT)
      p->AddToObject("type", MJsonNode::MakeString("object"));
   else if (mjson_type == MJSON_STRING)
      p->AddToObject("type", MJsonNode::MakeString("string"));
   else if (mjson_type == MJSON_INT)
      p->AddToObject("type", MJsonNode::MakeString("integer"));
   else if (mjson_type == MJSON_NUMBER)
      p->AddToObject("type", MJsonNode::MakeString("number"));
   else if (mjson_type == MJSON_BOOL)
      p->AddToObject("type", MJsonNode::MakeString("bool"));
   else if (mjson_type == MJSON_NULL)
      p->AddToObject("type", MJsonNode::MakeString("null"));
   else if (mjson_type == MJSON_ARRAYBUFFER)
      p->AddToObject("type", MJsonNode::MakeString("arraybuffer"));
   else if (mjson_type == MJSON_JSON)
      p->AddToObject("type", MJsonNode::MakeString("json"));
   else if (mjson_type == 0)
      ;
   else
      assert(!"invalid value of mjson_type");
   this->AddToSchema(p, name);
}

Here is the call graph for this function:

Here is the caller graph for this function:

AddArray()

MJSO * MJSO::AddArray	(	const char *	name,
		const char *	description
	)

Definition at line 393 of file mjsonrpc.cxx.

{
   MJSO* s = MakeArraySchema(description);
   s->AddToObject("description", MJsonNode::MakeString(description));
   s->AddToObject("type", MJsonNode::MakeString("array"));
   this->AddToSchema(s, name);
   return s;
}

Here is the call graph for this function:

AddObject()

MJSO * MJSO::AddObject	(	const char *	name,
		const char *	description
	)

Definition at line 384 of file mjsonrpc.cxx.

{
   MJSO* s = MakeObjectSchema(description);
   s->AddToObject("description", MJsonNode::MakeString(description));
   s->AddToObject("type", MJsonNode::MakeString("object"));
   this->AddToSchema(s, name);
   return s;
}

Here is the call graph for this function:

Here is the caller graph for this function:

AddToSchema()

void MJSO::AddToSchema ( MJsonNode *  s, const char *  name  )

protected

Definition at line 261 of file mjsonrpc.cxx.

{
   if (!xname)
      xname = "";
 
   bool optional = strchr(xname, '?');
   bool array = strchr(xname, '[');
 
   // remove the "?" and "[]" marker characters
   std::string name = xname;
   name = remove(name, '?');
   name = remove(name, '[');
   name = remove(name, ']');
 
   if (optional)
      s->AddToObject("optional", MJsonNode::MakeBool(true));
 
   if (array) { // insert an array schema
      MJSO* ss = MakeArraySchema(s->FindObjectNode("description")->GetString().c_str());
      s->DeleteObjectNode("description");
      ss->AddToSchema(s, "");
      s = ss;
   }
 
   if (items)
      items->AddToArray(s);
   else {
      assert(properties);
      assert(required);
      properties->AddToObject(name.c_str(), s);
      if (!optional) {
         required->AddToArray(MJsonNode::MakeString(name.c_str()));
      }
   }
}

Here is the call graph for this function:

Here is the caller graph for this function:

D()

void MJSO::D

(

const char *

description

)

Definition at line 302 of file mjsonrpc.cxx.

{
   this->AddToObject("description", MJsonNode::MakeString(description));
}

I()

MJSO * MJSO::I ( )

static

Definition at line 297 of file mjsonrpc.cxx.

{
   return MakeObjectSchema(NULL);
}

Here is the call graph for this function:

MakeArraySchema()

MJSO * MJSO::MakeArraySchema ( const char *  description )

staticprotected

Definition at line 242 of file mjsonrpc.cxx.

{
   MJSO* p = new MJSO();
   p->AddToObject("description", MJsonNode::MakeString(description));
   p->AddToObject("type", MJsonNode::MakeString("array"));
   p->items = MJsonNode::MakeArray();
   p->AddToObject("items", p->items);
   return p;
}

Here is the call graph for this function:

Here is the caller graph for this function:

MakeObjectSchema()

MJSO * MJSO::MakeObjectSchema ( const char *  description )

staticprotected

Definition at line 229 of file mjsonrpc.cxx.

{
   MJSO* p = new MJSO();
   if (description)
      p->AddToObject("description", MJsonNode::MakeString(description));
   p->AddToObject("type", MJsonNode::MakeString("object"));
   p->properties = MJsonNode::MakeObject();
   p->required = MJsonNode::MakeArray();
   p->AddToObject("properties", p->properties);
   p->AddToObject("required", p->required);
   return p;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mjsonrpc_add_handler()

void mjsonrpc_add_handler	(	const char *	method,
		mjsonrpc_handler_t *	handler,
		bool	needs_locking = false
	)

Definition at line 4637 of file mjsonrpc.cxx.

{
   MethodsTableEntry e;
   e.fHandler = handler;
   e.fNeedsLocking = needs_locking;
   gMethodsTable[method] = e;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mjsonrpc_decode_post_data()

MJsonNode* mjsonrpc_decode_post_data

(

const char *

post_data

)

Definition at line 5257 of file mjsonrpc.cxx.

{
   //printf("mjsonrpc call, data [%s]\n", post_data);
   MJsonNode *request = MJsonNode::Parse(post_data);
 
   assert(request != NULL); // Parse never returns NULL - either parsed data or an MJSON_ERROR node
 
   if (mjsonrpc_debug) {
      printf("mjsonrpc: request:\n");
      request->Dump();
      printf("\n");
   }
 
   if (mjsonrpc_sleep) {
      if (mjsonrpc_debug) {
         printf("mjsonrpc: sleep %d\n", mjsonrpc_sleep);
      }
      for (int i=0; i<mjsonrpc_sleep; i++) {
         sleep(1);
      }
   }
 
   if (request->GetType() == MJSON_ERROR) {
      MJsonNode* reply = mjsonrpc_make_error(-32700, "Parse error", request->GetError().c_str());
      reply->AddToObject("jsonrpc", MJsonNode::MakeString("2.0"));
      reply->AddToObject("id", MJsonNode::MakeNull());
 
      if (mjsonrpc_debug) {
         printf("mjsonrpc: invalid json: reply:\n");
         printf("%s\n", reply->Stringify().c_str());
         printf("\n");
      }
 
      delete request;
      return reply;
   } else if (request->GetType() == MJSON_OBJECT) {
      MJsonNode* reply = mjsonrpc_handle_request(request);
      delete request;
      return reply;
   } else if (request->GetType() == MJSON_ARRAY) {
      const MJsonNodeVector* a = request->GetArray();
 
      if (a->size() < 1) {
         MJsonNode* reply = mjsonrpc_make_error(-32600, "Invalid request", "batch request array has less than 1 element");
         reply->AddToObject("jsonrpc", MJsonNode::MakeString("2.0"));
         reply->AddToObject("id", MJsonNode::MakeNull());
         
         if (mjsonrpc_debug) {
            printf("mjsonrpc: invalid json: reply:\n");
            printf("%s\n", reply->Stringify().c_str());
            printf("\n");
         }
         
         delete request;
         return reply;
      }
 
      MJsonNode* reply = MJsonNode::MakeArray();
 
      for (unsigned i=0; i<a->size(); i++) {
         MJsonNode* r = mjsonrpc_handle_request(a->at(i));
         reply->AddToArray(r);
         if (r->GetType() == MJSON_ARRAYBUFFER) {
            delete request;
            delete reply;
            reply = mjsonrpc_make_error(-32600, "Invalid request", "MJSON_ARRAYBUFFER return is not permitted for batch requests");
            reply->AddToObject("jsonrpc", MJsonNode::MakeString("2.0"));
            reply->AddToObject("id", MJsonNode::MakeNull());
            return reply;
         }
      }
 
      delete request;
      return reply;
   } else {
      MJsonNode* reply = mjsonrpc_make_error(-32600, "Invalid request", "request is not a JSON object or JSON array");
      reply->AddToObject("jsonrpc", MJsonNode::MakeString("2.0"));
      reply->AddToObject("id", MJsonNode::MakeNull());
 
      if (mjsonrpc_debug) {
         printf("mjsonrpc: invalid json: reply:\n");
         printf("%s\n", reply->Stringify().c_str());
         printf("\n");
      }
 
      delete request;
      return reply;
   }
}

Here is the call graph for this function:

Here is the caller graph for this function:

mjsonrpc_exit()

void mjsonrpc_exit

(

)

Definition at line 4734 of file mjsonrpc.cxx.

{
   if (mjsonrpc_debug) {
      printf("mjsonrpc_exit!\n");
   }
 
   js_hs_exit();
   DeleteEventStash();
}

Here is the call graph for this function:

Here is the caller graph for this function:

mjsonrpc_get_param()

const MJsonNode* mjsonrpc_get_param	(	const MJsonNode *	params,
		const char *	name,
		MJsonNode **	error
	)

Definition at line 177 of file mjsonrpc.cxx.

{
   assert(gNullNode != NULL);
 
   // NULL params is a request for documentation, return an empty object
   if (!params) {
      if (error)
         *error = MJsonNode::MakeObject();
      return gNullNode;
   }
 
   const MJsonNode* obj = params->FindObjectNode(name);
   if (!obj) {
      if (error)
         *error = mjsonrpc_make_error(-32602, "Invalid params", (std::string("missing parameter: ") + name).c_str());
      return gNullNode;
   }
 
   if (error)
      *error = NULL;
   return obj;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mjsonrpc_get_schema()

MJsonNode* mjsonrpc_get_schema

(

)

Definition at line 4772 of file mjsonrpc.cxx.

{
   return mjsonrpc_make_schema(&gMethodsTable);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mjsonrpc_init()

void mjsonrpc_init

(

)

Definition at line 4650 of file mjsonrpc.cxx.

{
   if (mjsonrpc_debug) {
      printf("mjsonrpc_init!\n");
   }
 
   if (!gNullNode)
      gNullNode = MJsonNode::MakeNull();
 
   // test, debug and control methods for the rpc system
   mjsonrpc_add_handler("null", xnull);
   mjsonrpc_add_handler("get_debug",   get_debug);
   mjsonrpc_add_handler("set_debug",   set_debug);
   mjsonrpc_add_handler("get_sleep",   get_sleep);
   mjsonrpc_add_handler("set_sleep",   set_sleep);
   mjsonrpc_add_handler("get_time",    get_time);
   mjsonrpc_add_handler("set_time",    set_time);
   mjsonrpc_add_handler("get_schema",  get_schema);
   // interface to alarm functions
   mjsonrpc_add_handler("al_reset_alarm",    js_al_reset_alarm,    true);
   mjsonrpc_add_handler("al_trigger_alarm",  js_al_trigger_alarm,  true);
   mjsonrpc_add_handler("al_trigger_class",  js_al_trigger_class,  true);
   // interface to midas.c functions
   mjsonrpc_add_handler("cm_exist",          js_cm_exist,          true);
   mjsonrpc_add_handler("cm_msg_facilities", js_cm_msg_facilities);
   mjsonrpc_add_handler("cm_msg_retrieve",   js_cm_msg_retrieve);
   mjsonrpc_add_handler("cm_msg1",           js_cm_msg1);
   mjsonrpc_add_handler("cm_shutdown",   js_cm_shutdown,   true);
   mjsonrpc_add_handler("cm_transition", js_cm_transition, true);
   mjsonrpc_add_handler("bm_receive_event", js_bm_receive_event, true);
   // interface to odb functions
   mjsonrpc_add_handler("db_copy",     js_db_copy);
   mjsonrpc_add_handler("db_paste",    js_db_paste);
   mjsonrpc_add_handler("db_get_values", js_db_get_values);
   mjsonrpc_add_handler("db_ls",       js_db_ls);
   mjsonrpc_add_handler("db_create", js_db_create);
   mjsonrpc_add_handler("db_delete", js_db_delete);
   mjsonrpc_add_handler("db_resize", js_db_resize);
   mjsonrpc_add_handler("db_resize_string", js_db_resize_string);
   mjsonrpc_add_handler("db_rename", js_db_rename);
   mjsonrpc_add_handler("db_scl",    js_db_scl);
   mjsonrpc_add_handler("db_sor",    js_db_sor);
   mjsonrpc_add_handler("db_link",   js_db_link);
   mjsonrpc_add_handler("db_reorder", js_db_reorder);
   mjsonrpc_add_handler("db_key",    js_db_key);
   // interface to elog functions
   mjsonrpc_add_handler("el_retrieve", js_el_retrieve, true);
   mjsonrpc_add_handler("el_query",    js_el_query,    true);
   mjsonrpc_add_handler("el_delete",   js_el_delete,   true);
   // interface to midas history
   mjsonrpc_add_handler("hs_get_active_events", js_hs_get_active_events, true);
   mjsonrpc_add_handler("hs_get_channels", js_hs_get_channels, true);
   mjsonrpc_add_handler("hs_get_events", js_hs_get_events, true);
   mjsonrpc_add_handler("hs_get_tags", js_hs_get_tags, true);
   mjsonrpc_add_handler("hs_get_last_written", js_hs_get_last_written, true);
   mjsonrpc_add_handler("hs_reopen", js_hs_reopen, true);
   mjsonrpc_add_handler("hs_read", js_hs_read, true);
   mjsonrpc_add_handler("hs_read_binned", js_hs_read_binned, true);
   mjsonrpc_add_handler("hs_read_arraybuffer", js_hs_read_arraybuffer, true);
   mjsonrpc_add_handler("hs_read_binned_arraybuffer", js_hs_read_binned_arraybuffer, true);
   // interface to image history
   mjsonrpc_add_handler("hs_image_retrieve", js_hs_image_retrieve, true);
   // sequencer and file_picker
   mjsonrpc_add_handler("make_subdir", js_make_subdir, true);
   mjsonrpc_add_handler("ext_list_files", js_ext_list_files, true);
   mjsonrpc_add_handler("ext_save_file", js_ext_save_file, true);
   mjsonrpc_add_handler("ext_read_file", js_ext_read_file, true);
   // Read binary files of Uint8Arry
   mjsonrpc_add_handler("read_binary_file", js_read_binary_file, true);
   // interface to ss_system functions
   mjsonrpc_add_handler("ss_millitime", js_ss_millitime);
   // methods that perform computations or invoke actions
   mjsonrpc_add_handler("get_alarms",  get_alarms);
   //mjsonrpc_add_handler("get_messages",  get_messages);
   mjsonrpc_add_handler("jrpc",  jrpc);
   mjsonrpc_add_handler("brpc",  brpc);
   mjsonrpc_add_handler("start_program", start_program);
   mjsonrpc_add_handler("exec_script", exec_script);
   // timezone function
   mjsonrpc_add_handler("get_timezone", js_get_timezone);
 
   mjsonrpc_user_init();
}

Here is the caller graph for this function:

mjsonrpc_make_error()

MJsonNode* mjsonrpc_make_error	(	int	code,
		const char *	message,
		const char *	data
	)

Definition at line 122 of file mjsonrpc.cxx.

{
   MJsonNode* errnode = MJsonNode::MakeObject();
   errnode->AddToObject("code",    MJsonNode::MakeInt(code));
   errnode->AddToObject("message", MJsonNode::MakeString(message));
   errnode->AddToObject("data",    MJsonNode::MakeString(data));
 
   MJsonNode* result = MJsonNode::MakeObject();
   result->AddToObject("error", errnode);
   return result;
}

Here is the caller graph for this function:

mjsonrpc_make_result() [1/2]

MJsonNode* mjsonrpc_make_result	(	const char *	name,
		MJsonNode *	value,
		const char *	name2 = NULL,
		MJsonNode *	value2 = NULL,
		const char *	name3 = NULL,
		MJsonNode *	value3 = NULL
	)

Definition at line 141 of file mjsonrpc.cxx.

{
   MJsonNode* node = MJsonNode::MakeObject();
 
   if (name)
      node->AddToObject(name, value);
   if (name2)
      node->AddToObject(name2, value2);
   if (name3)
      node->AddToObject(name3, value3);
 
   MJsonNode* result = MJsonNode::MakeObject();
   result->AddToObject("result", node);
   return result;
}

mjsonrpc_make_result() [2/2]

MJsonNode* mjsonrpc_make_result

(

MJsonNode *

node

)

Definition at line 134 of file mjsonrpc.cxx.

{
   MJsonNode* result = MJsonNode::MakeObject();
   result->AddToObject("result", node);
   return result;
}

mjsonrpc_schema_to_text()

std::string mjsonrpc_schema_to_text

(

const MJsonNode *

schema

)

Definition at line 5082 of file mjsonrpc.cxx.

{
   std::string s;
   NestedOutput out;
   out.Clear();
   mjsonrpc_schema_to_html_anything(schema, 0, &out);
   //s += "<pre>\n";
   //s += nested_dump();
   //s += "</pre>\n";
   s += out.Print();
   return s;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mjsonrpc_set_std_mutex()

void mjsonrpc_set_std_mutex

(

void *

mutex

)

Definition at line 4645 of file mjsonrpc.cxx.

{
   gMutex = (std::mutex*)mutex;
}

Here is the caller graph for this function:

mjsonrpc_user_init()

void mjsonrpc_user_init

(

)

Definition at line 116 of file mjsonrpc_user.cxx.

{
   if (mjsonrpc_debug) {
      printf("mjsonrpc_user_init!\n");
   }
 
   // add user functions to the rpc list
 
   mjsonrpc_add_handler("user_example1", user_example1);
   mjsonrpc_add_handler("user_example2", user_example2);
   mjsonrpc_add_handler("user_example3", user_example3);
}

Here is the call graph for this function:

Here is the caller graph for this function:

P()

void MJSO::P	(	const char *	name,
		int	mjson_type,
		const char *	description
	)

Definition at line 339 of file mjsonrpc.cxx.

{
   if (name == NULL)
      this->Add("params", mjson_type, description);
   else
      Params()->Add(name, mjson_type, description);
}

Here is the call graph for this function:

PA()

MJSO * MJSO::PA

(

const char *

description

)

Definition at line 325 of file mjsonrpc.cxx.

{
   MJSO* s = MakeArraySchema(description);
   this->AddToSchema(s, "params");
   return s;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Params()

MJSO * MJSO::Params

(

)

Definition at line 307 of file mjsonrpc.cxx.

{
   if (!params) {
      params = MakeObjectSchema(NULL);
      this->AddToSchema(params, "params");
   }
   return params;
}

Here is the call graph for this function:

Here is the caller graph for this function:

R()

void MJSO::R	(	const char *	name,
		int	mjson_type,
		const char *	description
	)

Definition at line 347 of file mjsonrpc.cxx.

{
   if (name == NULL)
      this->Add("result", mjson_type, description);
   else
      Result()->Add(name, mjson_type, description);
}

Here is the call graph for this function:

RA()

MJSO * MJSO::RA

(

const char *

description

)

Definition at line 332 of file mjsonrpc.cxx.

{
   MJSO* s = MakeArraySchema(description);
   this->AddToSchema(s, "result");
   return s;
}

Here is the call graph for this function:

Result()

MJSO * MJSO::Result

(

)

Definition at line 316 of file mjsonrpc.cxx.

{
   if (!result) {
      result = MakeObjectSchema(NULL);
      this->AddToSchema(result, "result");
   }
   return result;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

items

MJsonNode* MJSO::items

protected

Definition at line 63 of file mjsonrpc.h.

mjsonrpc_debug

int mjsonrpc_debug

extern

Definition at line 111 of file mjsonrpc.cxx.

params

MJSO* MJSO::params

protected

Definition at line 65 of file mjsonrpc.h.

properties

MJsonNode* MJSO::properties

protected

Definition at line 61 of file mjsonrpc.h.

required

MJsonNode* MJSO::required

protected

Definition at line 62 of file mjsonrpc.h.

result

MJSO* MJSO::result

protected

Definition at line 66 of file mjsonrpc.h.