1 #ifndef _OSRF_APP_SESSION
2 #define _OSRF_APP_SESSION
4 #include <opensrf/transport_client.h>
5 #include <opensrf/osrf_message.h>
6 #include <opensrf/osrf_system.h>
7 #include <opensrf/string_array.h>
8 #include <opensrf/osrfConfig.h>
9 #include <opensrf/osrf_hash.h>
10 #include <opensrf/osrf_list.h>
12 #include <opensrf/osrf_json.h>
16 #define DEF_RECV_TIMEOUT 6 /* receive timeout */
17 #define DEF_QUEUE_SIZE
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 };
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, int* recvd );
25 struct osrf_app_request_struct {
26 /** Our controlling session */
27 struct osrf_app_session_struct* session;
31 /** True if we have received a 'request complete' message from our request */
33 /** Our original request payload */
34 osrf_message* payload;
35 /** List of responses to our request */
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 */
42 typedef struct osrf_app_request_struct osrf_app_request;
43 typedef struct osrf_app_request_struct osrfAppRequest;
45 struct osrf_app_session_struct {
47 /** Our messag passing object */
48 transport_client* transport_handle;
49 /** Cache of active app_request objects */
51 //osrfAppRequest* request_queue;
53 osrfList* request_queue;
55 /** The original remote id of the remote service we're talking to */
57 /** The current remote id of the remote service we're talking to */
60 /** Who we're talking to if we're a client.
61 what app we're serving if we're a server */
64 /** The current request thread_trace */
69 /* true if this session does not require connect messages */
72 /** The connect state */
73 enum OSRF_SESSION_STATE state;
75 /** SERVER or CLIENT */
76 enum OSRF_SESSION_TYPE type;
78 /** the current locale for this session **/
81 /* let the user use the session to store their own session data */
84 void (*userDataFree) (void*);
86 typedef struct osrf_app_session_struct osrf_app_session;
87 typedef struct osrf_app_session_struct osrfAppSession;
91 // --------------------------------------------------------------------------
93 // --------------------------------------------------------------------------
95 /** Allocates a initializes a new app_session */
96 osrfAppSession* osrfAppSessionClientInit( const char* remote_service );
97 osrfAppSession* osrf_app_client_session_init( const char* remote_service );
99 /** Allocates and initializes a new server session. The global session cache
100 * is checked to see if this session already exists, if so, it's returned
102 osrfAppSession* osrf_app_server_session_init(
103 const char* session_id, const char* our_app, const char* remote_id );
105 /** sets the default locale for a session **/
106 char* osrf_app_session_set_locale( osrfAppSession*, const char* );
108 /** returns a session from the global session hash */
109 osrfAppSession* osrf_app_session_find_session( const char* session_id );
111 /** Builds a new app_request object with the given payload andn returns
112 * the id of the request. This id is then used to perform work on the
115 int osrfAppSessionMakeRequest(
116 osrfAppSession* session, const jsonObject* params,
117 const char* method_name, int protocol, string_array* param_strings);
119 int osrf_app_session_make_req(
120 osrfAppSession* session, const jsonObject* params,
121 const char* method_name, int protocol, string_array* param_strings);
123 /** Sets the given request to complete state */
124 void osrf_app_session_set_complete( osrfAppSession* session, int request_id );
126 /** Returns true if the given request is complete */
127 int osrf_app_session_request_complete( const osrfAppSession* session, int request_id );
129 /** Does a recv call on the given request */
130 osrf_message* osrfAppSessionRequestRecv(
131 osrfAppSession* session, int request_id, int timeout );
132 osrf_message* osrf_app_session_request_recv(
133 osrfAppSession* session, int request_id, int timeout );
135 /** Removes the request from the request set and frees the reqest */
136 void osrf_app_session_request_finish( osrfAppSession* session, int request_id );
138 /** Resends the orginal request with the given request id */
139 int osrf_app_session_request_resend( osrfAppSession*, int request_id );
141 /** Resets the remote connection target to that of the original*/
142 void osrf_app_session_reset_remote( osrfAppSession* );
144 /** Sets the remote target to 'remote_id' */
145 void osrf_app_session_set_remote( osrfAppSession* session, const char* remote_id );
147 /** pushes the given message into the result list of the app_request
148 * whose request_id matches the messages thread_trace
150 int osrf_app_session_push_queue( osrfAppSession*, osrf_message* msg );
152 /** Attempts to connect to the remote service. Returns 1 on successful
153 * connection, 0 otherwise.
155 int osrf_app_session_connect( osrfAppSession* );
156 int osrfAppSessionConnect( osrfAppSession* );
158 /** Sends a disconnect message to the remote service. No response is expected */
159 int osrf_app_session_disconnect( osrfAppSession* );
161 /** Waits up to 'timeout' seconds for some data to arrive.
162 * Any data that arrives will be processed according to its
163 * payload and message type. This method will return after
164 * any data has arrived.
166 int osrf_app_session_queue_wait( osrfAppSession*, int timeout, int* recvd );
168 /** Disconnects (if client), frees any attached app_reuqests, removes the session from the
169 * global session cache and frees the session. Needless to say, only call this when the
170 * session is completey done.
172 void osrf_app_session_destroy ( osrfAppSession* );
173 void osrfAppSessionFree( osrfAppSession* );
175 /* tells the request to reset it's wait timeout */
176 void osrf_app_session_request_reset_timeout( osrfAppSession* session, int req_id );
178 int osrfAppRequestRespond( osrfAppSession* ses, int requestId, const jsonObject* data );
179 int osrfAppRequestRespondComplete(
180 osrfAppSession* ses, int requestId, const jsonObject* data );
182 int osrfAppSessionStatus( osrfAppSession* ses, int type,
183 const char* name, int reqId, const char* message );
185 void osrfAppSessionCleanup();