Midas C++ API - RPC functions

INT cm_query_transition(int *transition, int *run_number, int *trans_time)

Query system if transition has occured. Normally, one registers callbacks for transitions via cm_register_transition. In some environments however, callbacks are not possible. In that case one spciefies a NULL pointer as the callback routine and can query transitions "manually" by calling this functions. A small FIFO takes care that no transition is lost if this functions did not get called between some transitions.

Parameters:

• transition (int *) [out] –
  Type of transition, one of TR_xxx
• run_number (int *)
• trans_time (int *) [out] –
  Time (in UNIX time) of transition
• run_nuber [out] –
  Run number for transition

Returns:

• FALSE –
  No transition occured since last call
• TRUE –
  Transition occured

Declared in include/midas.h:1712, defined in src/midas.cxx:14631

INT recv_tcp_check(int sock)

Check if in TCP receive buffer associated with sock is some data. Called by ss_suspend.

Parameters:

• sock (int) [in] –
  TCP receive socket

Returns:

• INT –
  count Number of bytes remaining in TCP buffer

Declared in include/msystem.h:576, defined in src/midas.cxx:14866

INT rpc_add_allowed_host(const char* hostname)

Permit connections from listed hosts only

Returns:

• RPC_SUCCESS –
  Successful completion
• RPC_NO_MEMORY –
  Too many allowed hosts

Declared in include/midas.h:1976, defined in src/midas.cxx:16668

INT rpc_check_allowed_host(const char* hostname)

Check if hostname is permitted to connect

Returns:

• RPC_SUCCESS –
  hostname is permitted to connect
• RPC_NOT_REGISTERED –
  hostname not permitted to connect

Declared in include/midas.h:1977, defined in src/midas.cxx:16697

INT rpc_check_channels()

Check open rpc channels by sending watchdog messages

Returns:

• RPC_SUCCESS –
  Channel is still alive
• RPC_NET_ERROR –
  Connection is broken

Declared in include/msystem.h:578, defined in src/midas.cxx:17717

INT rpc_clear_allowed_hosts()

Clear list of allowed hosts and permit connections from anybody

Returns:

• RPC_SUCCESS –
  Successful completion

Declared in include/midas.h:1975, defined in src/midas.cxx:16643

INT rpc_client_accept(int sock)

midas program accept new RPC connection (run transitions, etc)

Parameters:

• sock (int) [in] –
  Listen socket

Returns:

• RPC_SUCCESS –
  Successful completion
• RPC_NET_ERROR –
  Error in socket call
• RPC_CONNCLOSED –
  Connection was closed
• RPC_SHUTDOWN –
  Listener shutdown
• RPC_EXCEED_BUFFER –
  Not enough memory for network buffer

Declared in include/msystem.h:573, defined in src/midas.cxx:17031

void rpc_convert_data(void *data, INT tid, INT flags, INT size, INT convert_flags)

Convert data format between differenct computers

Parameters:

• data (void *) [in,out] –
  Pointer to data
  Is converted according to _convert_flag value
• tid (INT) [in] –
  Type ID of data, one of TID_xxx
• flags (INT) [in] –
  Combination of following flags:
  RPC_IN: data is input parameter
  RPC_OUT: data is output variable
  RPC_FIXARRAY, RPC_VARARRAY: data is array
  of "size" bytes (see next param.)
  RPC_OUTGOING: data is outgoing
• size (INT) [in] –
  Size of bytes of data. Used for variable length arrays.
• convert_flags (INT) [in] –
  Flags for data conversion

Returns:

• RPC_SUCCESS –
  Successful completion

Declared in include/midas.h:2017, defined in src/midas.cxx:11900

void rpc_convert_single(void *data, INT tid, INT flags, INT convert_flags)

Declared in include/midas.h:2016, defined in src/midas.cxx:11875

INT rpc_flush_event()

Send event residing in the TCP cache buffer filled by rpc_send_event. This routine should be called when a run is stopped.

Returns:

• INT –
  RPC_SUCCESS, RPC_NET_ERROR

Declared in include/midas.h:2008, defined in src/midas.cxx:14549

int rpc_flush_event_socket(int timeout_msec)

Receive and en-buffer events from the mserver event socket

Returns:

• BM_SUCCESS –
  Event socket is empty, all data was read an en-buffered
• BM_ASYNC_RETURN –
  Event socket has unread data or event buffer is full and rpc_server_receive_event() has an un-buffered event.
• SS_EXIT –
  Server connection was closed
• SS_ABORT –
  Server connection was broken

Declared in include/msystem.h:663, defined in src/midas.cxx:17599

void rpc_get_convert_flags(INT * convert_flags)

Declared in include/midas.h:2015, defined in src/midas.cxx:11800

RPC_SERVER_ACCEPTION*rpc_get_mserver_acception()

Declared in include/msystem.h:585, defined in src/midas.cxx:11707

INT rpc_get_timeout(HNDLE hConn)

Set RPC option

Get RPC timeout

Parameters:

• hConn (HNDLE) –
  RPC connection handle, -1 for server connection, -2 for rpc connect timeout
• item –
  One of RPC_Oxxx
• value –
  Value to set

Returns:

• INT –
  RPC_SUCCESS
• timeout value

Declared in include/midas.h:1982, defined in src/midas.cxx:13167

INT rpc_name_tid(const char* name)

inverse of rpc_tid_name()

Declared in include/midas.h:2002, defined in src/midas.cxx:11972

INT rpc_register_client(const char *name, RPC_LIST * list)

Register RPC client for standalone mode (without standard midas server)

Parameters:

• name (const char *) –
  Name of this client
• list (RPC_LIST *) –
  Array of RPC_LIST structures containing function IDs and parameter definitions. The end of the list must be indicated by a function ID of zero.

Returns:

• INT –
  RPC_SUCCESS

Declared in include/midas.h:1994, defined in src/midas.cxx:12002

INT rpc_register_functions(const RPC_LIST * new_list, RPC_HANDLER func)

Register a set of RPC functions (both as clients or servers)

Parameters:

• new_list (const RPC_LIST *) –
  Array of RPC_LIST structures containing function IDs and parameter definitions. The end of the list must be indicated by a function ID of zero.
• func (RPC_HANDLER) –
  Default dispatch function

Returns:

• INT –
  RPC_SUCCESS, RPC_NO_MEMORY, RPC_DOUBLE_DEFINED

Declared in include/midas.h:1979, defined in src/midas.cxx:12021

INT rpc_register_listener(int port, RPC_HANDLER func, int *plsock, int *pport)

Register the calling process as a MIDAS RPC server. Note that cm_connnect_experiment must be called prior to any call of rpc_register_listener.

Parameters:

• port (int) [in] –
  TCP port for listen. If port==0, the OS chooses a free port and returns it in *pport
• func (RPC_HANDLER) [in] –
  Default dispatch function
• plsock (int *) [out] –
  Listener socket, should not be NULL
• pport (int *) [out] –
  Port under which server is listening, can be NULL

Returns:

• RPC_SUCCESS –
  Successful completion
• RPC_NET_ERROR –
  Error in socket call
• RPC_NOT_REGISTERED –
  cm_connect_experiment was not called

Declared in include/msystem.h:567, defined in src/midas.cxx:15088

INT rpc_register_server(int port, int *plsock, int *pport)

Register the calling process as a MIDAS RPC server. Note that cm_connnect_experiment must be called prior to any call of rpc_register_server.

Parameters:

• port (int) [in] –
  TCP port for listen. If port==0, the OS chooses a free port and returns it in *pport
• plsock (int *) [out] –
  Listener socket, can be NULL
• pport (int *) [out] –
  Port under which server is listening, can be NULL

Returns:

• RPC_SUCCESS –
  Successful completion
• RPC_NET_ERROR –
  Error in socket call
• RPC_NOT_REGISTERED –
  cm_connect_experiment was not called

Declared in include/midas.h:1993, defined in src/midas.cxx:15047

INT rpc_send_event(INT buffer_handle, const EVENT_HEADER *event, int unused, INT async_flag, INT mode)

Fast send_event routine which bypasses the RPC layer and sends the event directly at the TCP level.

Parameters:

• buffer_handle (INT) –
  Handle of the buffer to send the event to. Must be obtained via bm_open_buffer.
• event (const EVENT_HEADER *)
• unused (int)
• async_flag (INT) –
  BM_WAIT / BM_NO_WAIT flag. In BM_NO_WAIT mode, the function returns immediately if it cannot send the event over the network. In BM_WAIT mode, it waits until the packet is sent (blocking).
• mode (INT) –
  Determines in which mode the event is sent. If zero, use RPC socket, if one, use special event socket to bypass RPC layer on the server side.
• source –
  Address of the event to send. It must have a proper event header.
• buf_size –
  Size of event in bytes with header.

Returns:

• INT –
  BM_INVALID_PARAM, BM_ASYNC_RETURN, RPC_SUCCESS, RPC_NET_ERROR, RPC_NO_CONNECTION, RPC_EXCEED_BUFFER

Declared in include/midas.h:2007, defined in src/midas.cxx:14412

INT rpc_send_event1(INT buffer_handle, const EVENT_HEADER *event)

Send event to mserver using the event socket connection, bypassing the RPC layer

Parameters:

• buffer_handle (INT) –
  Handle of the buffer to send the event to. Must be obtained via bm_open_buffer.
• event (const EVENT_HEADER *) –
  Pointer to event header

Returns:

• INT –
  RPC_SUCCESS, RPC_NET_ERROR, RPC_NO_CONNECTION

Declared in include/midas.h:2010, defined in src/midas.cxx:14430

INT rpc_send_event_sg(INT buffer_handle, int sg_n, const char* const sg_ptr[], const size_t sg_len[])

Declared in include/midas.h:2011, defined in src/midas.cxx:14436

INT rpc_server_accept(int sock)

Accept new incoming connections

Parameters:

• sock (int)
• lscok [in] –
  Listen socket

Returns:

• RPC_SUCCESS –
  Successful completion
• RPC_NET_ERROR –
  Error in socket call
• RPC_CONNCLOSED –
  Connection was closed
• RPC_SHUTDOWN –
  Listener shutdown
• RPC_EXCEED_BUFFER –
  Not enough memory for network buffer

Declared in include/msystem.h:572, defined in src/midas.cxx:16774

INT rpc_server_callback(struct callback_addr *callback)

Callback a remote client. Setup _server_acception entry with optional conversion flags and establish two-way TCP connection.

Returns:

• RPC_SUCCESS –
  Successful completion

Declared in include/msystem.h:571, defined in src/midas.cxx:17135

INT rpc_server_loop()

mserver main event loop

Declared in include/midas.h:1995, defined in src/midas.cxx:17276

INT rpc_server_receive_event(int idx, RPC_SERVER_ACCEPTION* sa, int timeout_msec)

Receive event and dispatch it

Returns:

• RPC_SUCCESS –
  Successful completion
• RPC_EXCEED_BUFFER –
  Not enough memeory to allocate buffer
• SS_EXIT –
  Server connection was closed
• SS_ABORT –
  Server connection was broken

Declared in include/msystem.h:570, defined in src/midas.cxx:17444

INT rpc_server_receive_rpc(RPC_SERVER_ACCEPTION* sa)

Receive rpc commands and execute them. Close the connection if client has broken TCP pipe.

Returns:

• RPC_SUCCESS –
  Successful completion
• RPC_EXCEED_BUFFER –
  Not enough memeory to allocate buffer
• SS_EXIT –
  Server connection was closed
• SS_ABORT –
  Server connection was broken

Declared in include/msystem.h:569, defined in src/midas.cxx:17304

INT rpc_server_shutdown()

Shutdown RPC server, abort all connections

Returns:

• RPC_SUCCESS –
  Successful completion

Declared in include/midas.h:1996, defined in src/midas.cxx:17646

INT rpc_set_timeout(HNDLE hConn, int timeout_msec, int* old_timeout_msec = NULL)

Set RPC timeout

Parameters:

• hConn (HNDLE) –
  RPC connection handle, RPC_HNDLE_MSERVER for mserver connection, RPC_HNDLE_CONNECT for rpc connect timeout
• timeout_msec (int) –
  RPC timeout in milliseconds
• old_timeout_msec (int*, default: NULL) –
  returns old value of RPC timeout in milliseconds

Returns:

• INT –
  RPC_SUCCESS

Declared in include/midas.h:1983, defined in src/midas.cxx:13192

INT rpc_test_rpc()

Test RPC parameters encoding and decoding

Returns:

• RPC_SUCCESS –
  Successful completion

Declared in include/midas.h:2013, defined in src/midas.cxx:16605

const char *rpc_tid_name(INT id)

Declared in include/midas.h:2000, defined in src/midas.cxx:11958

const char *rpc_tid_name_old(INT id)

Declared in include/midas.h:2001, defined in src/midas.cxx:11965

INT rpc_tid_size(INT id)

Declared in include/midas.h:1999, defined in src/midas.cxx:11951

RPC_LIST *rpc_get_internal_list(INT flag)

Declared in include/msystem.h:568, defined in src/mrpc.cxx:785

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

Declared in include/mjsonrpc.h:24, defined in src/mjsonrpc.cxx:4985

MJsonNode*mjsonrpc_decode_post_data(const char* post_data)

printf("mjsonrpc call, data [%s]\n", post_data);

Declared in include/mjsonrpc.h:37, defined in src/mjsonrpc.cxx:5614

void mjsonrpc_exit()

Declared in include/mjsonrpc.h:25, defined in src/mjsonrpc.cxx:5090

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

Declared in include/mjsonrpc.h:35, defined in src/mjsonrpc.cxx:182

MJsonNode*mjsonrpc_get_schema()

Declared in include/mjsonrpc.h:29, defined in src/mjsonrpc.cxx:5128

void mjsonrpc_init()

Declared in include/mjsonrpc.h:22, defined in src/mjsonrpc.cxx:4998

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

Declared in include/mjsonrpc.h:32, defined in src/mjsonrpc.cxx:127

std::string mjsonrpc_schema_to_text(const MJsonNode *schema)

Declared in include/mjsonrpc.h:30, defined in src/mjsonrpc.cxx:5438

void mjsonrpc_set_std_mutex(void* mutex)

Declared in include/mjsonrpc.h:27, defined in src/mjsonrpc.cxx:4993

void mjsonrpc_user_init()

Declared in include/mjsonrpc.h:23, defined in src/mjsonrpc_user.cxx:116