2 @file osrf_app_session.h
3 @brief Header for osrfAppSession.
6 #ifndef OSRF_APP_SESSION_H
7 #define OSRF_APP_SESSION_H
9 #include "opensrf/transport_client.h"
10 #include "opensrf/osrf_message.h"
11 #include "opensrf/osrf_system.h"
12 #include "opensrf/string_array.h"
13 #include "opensrf/osrfConfig.h"
14 #include "opensrf/osrf_hash.h"
15 #include "opensrf/osrf_list.h"
16 #include "opensrf/osrf_json.h"
22 enum OSRF_SESSION_STATE {
23 OSRF_SESSION_CONNECTING,
24 OSRF_SESSION_CONNECTED,
25 OSRF_SESSION_DISCONNECTED
28 enum OSRF_SESSION_TYPE {
33 struct osrf_app_request_struct;
34 typedef struct osrf_app_request_struct osrfAppRequest;
36 #define OSRF_REQUEST_HASH_SIZE 64
39 @brief Default size of output buffer.
41 #define OSRF_MSG_BUNDLE_SIZE 25600 /* 25K */
42 #define OSRF_MSG_CHUNK_SIZE (OSRF_MSG_BUNDLE_SIZE * 2)
45 @brief Representation of a session with another application.
47 An osrfAppSession is a list of lists. It includes a list of osrfAppRequests
48 representing outstanding requests. Each osrfAppRequest includes a list of
51 struct osrf_app_session_struct {
53 /** Our message passing object */
54 transport_client* transport_handle;
56 /** The original remote id of the remote service we're talking to */
58 /** The current remote id of the remote service we're talking to */
61 /** Whom we're talking to if we're a client;
62 what app we're serving if we're a server */
65 /** The current request thread_trace */
70 /** Boolean; true if this session does not require connect messages.
71 Assigned a value depending on the compile-time macro ASSUME_STATELESS. */
74 /** The connect state */
75 enum OSRF_SESSION_STATE state;
77 /** SERVER or CLIENT */
78 enum OSRF_SESSION_TYPE type;
80 /** the current locale for this session. **/
83 /** the current TZ for this session. **/
86 /** let the user use the session to store their own session data. */
89 /** Callback function for freeing user's session data. */
90 void (*userDataFree) (void*);
94 /** Hash table of pending requests. */
95 osrfAppRequest* request_hash[ OSRF_REQUEST_HASH_SIZE ];
97 /** Boolean: true if the app wants to terminate the process. Typically this means that */
98 /** a drone has lost its database connection and can therefore no longer function. */
101 /** Buffer used by server drone to collect outbound response messages */
102 growing_buffer* outbuf;
104 typedef struct osrf_app_session_struct osrfAppSession;
106 // --------------------------------------------------------------------------
108 // --------------------------------------------------------------------------
110 osrfAppSession* osrfAppSessionClientInit( const char* remote_service );
112 osrfAppSession* osrf_app_server_session_init(
113 const char* session_id, const char* our_app, const char* remote_id );
115 char* osrf_app_session_set_locale( osrfAppSession*, const char* );
117 char* osrf_app_session_set_tz( osrfAppSession*, const char* );
119 /* ingress used by all sessions until replaced */
120 char* osrfAppSessionSetIngress( const char* );
122 const char* osrfAppSessionGetIngress();
124 osrfAppSession* osrf_app_session_find_session( const char* session_id );
126 /* DEPRECATED; use osrfAppSessionSendRequest() instead. */
127 int osrfAppSessionMakeRequest(
128 osrfAppSession* session, const jsonObject* params,
129 const char* method_name, int protocol, osrfStringArray* param_strings);
131 int osrfAppSessionSendRequest(
132 osrfAppSession* session, const jsonObject* params,
133 const char* method_name, int protocol );
135 void osrf_app_session_set_complete( osrfAppSession* session, int request_id );
137 int osrf_app_session_request_complete( const osrfAppSession* session, int request_id );
139 osrfMessage* osrfAppSessionRequestRecv(
140 osrfAppSession* session, int request_id, int timeout );
142 void osrf_app_session_request_finish( osrfAppSession* session, int request_id );
144 int osrf_app_session_request_resend( osrfAppSession*, int request_id );
146 int osrfSendTransportPayload( osrfAppSession* session, const char* payload );
148 void osrf_app_session_reset_remote( osrfAppSession* );
150 void osrf_app_session_set_remote( osrfAppSession* session, const char* remote_id );
152 void osrf_app_session_push_queue( osrfAppSession*, osrfMessage* msg );
154 int osrfAppSessionConnect( osrfAppSession* );
156 int osrf_app_session_disconnect( osrfAppSession* );
158 int osrf_app_session_queue_wait( osrfAppSession*, int timeout, int* recvd );
160 void osrfAppSessionFree( osrfAppSession* );
162 void osrf_app_session_request_reset_timeout( osrfAppSession* session, int req_id );
164 int osrfAppRequestRespond( osrfAppSession* ses, int requestId, const jsonObject* data );
166 int osrfAppRequestRespondComplete(
167 osrfAppSession* ses, int requestId, const jsonObject* data );
169 int osrfAppSessionStatus( osrfAppSession* ses, int type,
170 const char* name, int reqId, const char* message );
172 void osrfAppSessionCleanup( void );
174 void osrfAppSessionPanic( osrfAppSession* ses );