src/libstack/osrf_app_session.h

   1 #ifndef _OSRF_APP_SESSION
   2 #define _OSRF_APP_SESSION
   3
   4 #include "opensrf/transport_client.h"
   5 #include "objson/object.h"
   6 #include "osrf_message.h"
   7 #include "osrf_system.h"
   8 #include "opensrf/string_array.h"
   9 #include "osrfConfig.h"
  10
  11 #include "objson/object.h"
  12 #include "objson/json_parser.h"
  13
  14
  15
  16 #define DEF_RECV_TIMEOUT 6 /* receive timeout */
  17 #define DEF_QUEUE_SIZE
  18
  19 enum OSRF_SESSION_STATE { OSRF_SESSION_CONNECTING, OSRF_SESSION_CONNECTED, OSRF_SESSION_DISCONNECTED };
  20 enum OSRF_SESSION_TYPE { OSRF_SESSION_SERVER, OSRF_SESSION_CLIENT };
  21
  22 /* entry point for data into the stack.  gets set in osrf_stack.c */
  23 int (*osrf_stack_entry_point) (transport_client* client, int timeout );
  24
  25 struct osrf_app_request_struct {
  26         /** Our controlling session */
  27         struct osrf_app_session_struct* session;
  28
  29         /** our "id" */
  30         int request_id;
  31         /** True if we have received a 'request complete' message from our request */
  32         int complete;
  33         /** Our original request payload */
  34         osrf_message* payload;
  35         /** List of responses to our request */
  36         osrf_message* result;
  37
  38         /* if set to true, then a call that is waiting on a response, will reset the
  39                 timeout and set this variable back to false */
  40         int reset_timeout;
  41
  42         /** So we can be listified */
  43         struct osrf_app_request_struct* next;
  44 };
  45 typedef struct osrf_app_request_struct osrf_app_request;
  46 typedef struct osrf_app_request_struct osrfAppRequest;
  47
  48 struct osrf_app_session_struct {
  49
  50         /** Our messag passing object */
  51         transport_client* transport_handle;
  52         /** Cache of active app_request objects */
  53         osrf_app_request* request_queue;
  54
  55         /** The original remote id of the remote service we're talking to */
  56         char* orig_remote_id;
  57         /** The current remote id of the remote service we're talking to */
  58         char* remote_id;
  59
  60         /** Who we're talking to if we're a client.
  61                 what app we're serving if we're a server */
  62         char* remote_service;
  63
  64         /** The current request thread_trace */
  65         int thread_trace;
  66         /** Our ID */
  67         char* session_id;
  68
  69         /* true if this session does not require connect messages */
  70         int stateless;
  71
  72         /** The connect state */
  73         enum OSRF_SESSION_STATE state;
  74
  75         /** SERVER or CLIENT */
  76         enum OSRF_SESSION_TYPE type;
  77
  78         /** So we can be listified */
  79         struct osrf_app_session_struct* next;
  80
  81 };
  82 typedef struct osrf_app_session_struct osrf_app_session;
  83 typedef struct osrf_app_session_struct osrfAppSession;
  84
  85
  86
  87 // --------------------------------------------------------------------------
  88 // PUBLIC API ***
  89 // --------------------------------------------------------------------------
  90
  91 /** Allocates a initializes a new app_session */
  92 osrf_app_session* osrf_app_client_session_init( char* remote_service );
  93
  94 /** Allocates and initializes a new server session.  The global session cache
  95   * is checked to see if this session already exists, if so, it's returned
  96   */
  97 osrf_app_session* osrf_app_server_session_init(
  98                 char* session_id, char* our_app, char* remote_id );
  99
 100 /** returns a session from the global session hash */
 101 osrf_app_session* osrf_app_session_find_session( char* session_id );
 102
 103 /** Builds a new app_request object with the given payload andn returns
 104   * the id of the request.  This id is then used to perform work on the
 105   * requeset.
 106   */
 107 int osrf_app_session_make_req(
 108                 osrf_app_session* session, jsonObject* params,
 109                 char* method_name, int protocol, string_array* param_strings);
 110
 111 /** Sets the given request to complete state */
 112 void osrf_app_session_set_complete( osrf_app_session* session, int request_id );
 113
 114 /** Returns true if the given request is complete */
 115 int osrf_app_session_request_complete( osrf_app_session* session, int request_id );
 116
 117 /** Does a recv call on the given request */
 118 osrf_message* osrf_app_session_request_recv(
 119                 osrf_app_session* session, int request_id, int timeout );
 120
 121 /** Removes the request from the request set and frees the reqest */
 122 void osrf_app_session_request_finish( osrf_app_session* session, int request_id );
 123
 124 /** Resends the orginal request with the given request id */
 125 int osrf_app_session_request_resend( osrf_app_session*, int request_id );
 126
 127 /** Resets the remote connection target to that of the original*/
 128 void osrf_app_session_reset_remote( osrf_app_session* );
 129
 130 /** Sets the remote target to 'remote_id' */
 131 void osrf_app_session_set_remote( osrf_app_session* session, char* remote_id );
 132
 133 /** pushes the given message into the result list of the app_request
 134   * whose request_id matches the messages thread_trace
 135   */
 136 int osrf_app_session_push_queue( osrf_app_session*, osrf_message* msg );
 137
 138 /** Attempts to connect to the remote service. Returns 1 on successful
 139   * connection, 0 otherwise.
 140   */
 141 int osrf_app_session_connect( osrf_app_session* );
 142
 143 /** Sends a disconnect message to the remote service.  No response is expected */
 144 int osrf_app_session_disconnect( osrf_app_session* );
 145
 146 /**  Waits up to 'timeout' seconds for some data to arrive.
 147   * Any data that arrives will be processed according to its
 148   * payload and message type.  This method will return after
 149   * any data has arrived.
 150   */
 151 int osrf_app_session_queue_wait( osrf_app_session*, int timeout );
 152
 153 /** Disconnects (if client), frees any attached app_reuqests, removes the session from the
 154   * global session cache and frees the session.  Needless to say, only call this when the
 155   * session is completey done.
 156   */
 157 void osrf_app_session_destroy ( osrf_app_session* );
 158
 159
 160
 161 // --------------------------------------------------------------------------
 162 // --------------------------------------------------------------------------
 163 // Request functions
 164 // --------------------------------------------------------------------------
 165
 166 /** Allocations and initializes a new app_request object */
 167 osrf_app_request* _osrf_app_request_init( osrf_app_session* session, osrf_message* msg );
 168
 169 /** Frees memory used by an app_request object */
 170 void _osrf_app_request_free( osrf_app_request * req );
 171
 172 /** Pushes the given message onto the list of 'responses' to this request */
 173 void _osrf_app_request_push_queue( osrf_app_request*, osrf_message* payload );
 174
 175 /** Checks the receive queue for messages.  If any are found, the first
 176   * is popped off and returned.  Otherwise, this method will wait at most timeout
 177   * seconds for a message to appear in the receive queue.  Once it arrives it is returned.
 178   * If no messages arrive in the timeout provided, null is returned.
 179   */
 180 osrf_message* _osrf_app_request_recv( osrf_app_request* req, int timeout );
 181
 182 /** Resend this requests original request message */
 183 int _osrf_app_request_resend( osrf_app_request* req );
 184
 185
 186 /* tells the request to reset it's wait timeout */
 187 void osrf_app_session_request_reset_timeout( osrf_app_session* session, int req_id );
 188
 189 // --------------------------------------------------------------------------
 190 // --------------------------------------------------------------------------
 191 // Session functions
 192 // --------------------------------------------------------------------------
 193
 194 /** Returns the app_request with the given thread_trace (request_id) */
 195 osrf_app_request* _osrf_app_session_get_request( osrf_app_session*, int thread_trace );
 196
 197 /** frees memory held by a session. Note: We delete all requests in the request list */
 198 void _osrf_app_session_free( osrf_app_session* );
 199
 200 /** adds a session to the global session cache */
 201 void _osrf_app_session_push_session( osrf_app_session* );
 202
 203 /** removes from global session cache */
 204 void _osrf_app_session_remove_session( char* session_id );
 205
 206 /** Adds an app_request to the request set */
 207 void _osrf_app_session_push_request( osrf_app_session*, osrf_app_request* req );
 208
 209 /** Removes an app_request from this session request set, freeing the request object */
 210 void _osrf_app_session_remove_request( osrf_app_session*, osrf_app_request* req );
 211
 212 /** Send the given message */
 213 int _osrf_app_session_send( osrf_app_session*, osrf_message* msg );
 214
 215 int osrfAppRequestRespond( osrfAppSession* ses, int requestId, jsonObject* data );
 216
 217 int osrfAppSessionStatus( osrfAppSession* ses, int type, int reqId, char* message );
 218
 219
 220 #endif