1 #include "opensrf/transport_client.h"
2 #include "osrf_message.h"
3 #include "osrf_system.h"
4 #include "string_array.h"
5 #include "osrf_config.h"
7 #include "objson/object.h"
8 #include "objson/json_parser.h"
10 #ifndef OSRF_APP_SESSION
11 #define OSRF_APP_SESSION
14 #define DEF_RECV_TIMEOUT 6 /* receive timeout */
15 #define DEF_QUEUE_SIZE
17 enum OSRF_SESSION_STATE { OSRF_SESSION_CONNECTING, OSRF_SESSION_CONNECTED, OSRF_SESSION_DISCONNECTED };
18 enum OSRF_SESSION_TYPE { OSRF_SESSION_SERVER, OSRF_SESSION_CLIENT };
20 struct osrf_app_request_struct {
21 /** Our controlling session */
22 struct osrf_app_session_struct* session;
26 /** True if we have received a 'request complete' message from our request */
28 /** Our original request payload */
29 osrf_message* payload;
30 /** List of responses to our request */
33 /* if set to true, then a call that is waiting on a response, will reset the
34 timeout and set this variable back to false */
37 /** So we can be listified */
38 struct osrf_app_request_struct* next;
40 typedef struct osrf_app_request_struct osrf_app_request;
42 struct osrf_app_session_struct {
44 /** Our messag passing object */
45 transport_client* transport_handle;
46 /** Cache of active app_request objects */
47 osrf_app_request* request_queue;
49 /** The original remote id of the remote service we're talking to */
51 /** The current remote id of the remote service we're talking to */
54 /** Who we're talking to */
57 /** The current request thread_trace */
62 /* true if this session does not require connect messages */
65 /** The connect state */
66 enum OSRF_SESSION_STATE state;
68 /** SERVER or CLIENT */
69 enum OSRF_SESSION_TYPE type;
71 /** So we can be listified */
72 struct osrf_app_session_struct* next;
75 typedef struct osrf_app_session_struct osrf_app_session;
79 // --------------------------------------------------------------------------
81 // --------------------------------------------------------------------------
83 /** Allocates a initializes a new app_session */
84 osrf_app_session* osrf_app_client_session_init( char* remote_service );
86 /** Allocates and initializes a new server session. The global session cache
87 * is checked to see if this session already exists, if so, it's returned
89 osrf_app_session* osrf_app_server_session_init(
90 char* session_id, char* our_app, char* remote_service, char* remote_id );
92 /** returns a session from the global session hash */
93 osrf_app_session* osrf_app_session_find_session( char* session_id );
95 /** Builds a new app_request object with the given payload andn returns
96 * the id of the request. This id is then used to perform work on the
99 int osrf_app_session_make_req(
100 osrf_app_session* session, object* params,
101 char* method_name, int protocol, string_array* param_strings);
103 /** Sets the given request to complete state */
104 void osrf_app_session_set_complete( osrf_app_session* session, int request_id );
106 /** Returns true if the given request is complete */
107 int osrf_app_session_request_complete( osrf_app_session* session, int request_id );
109 /** Does a recv call on the given request */
110 osrf_message* osrf_app_session_request_recv(
111 osrf_app_session* session, int request_id, int timeout );
113 /** Removes the request from the request set and frees the reqest */
114 void osrf_app_session_request_finish( osrf_app_session* session, int request_id );
116 /** Resends the orginal request with the given request id */
117 int osrf_app_session_request_resend( osrf_app_session*, int request_id );
119 /** Resets the remote connection target to that of the original*/
120 void osrf_app_session_reset_remote( osrf_app_session* );
122 /** Sets the remote target to 'remote_id' */
123 void osrf_app_session_set_remote( osrf_app_session* session, char* remote_id );
125 /** pushes the given message into the result list of the app_request
126 * whose request_id matches the messages thread_trace
128 int osrf_app_session_push_queue( osrf_app_session*, osrf_message* msg );
130 /** Attempts to connect to the remote service. Returns 1 on successful
131 * connection, 0 otherwise.
133 int osrf_app_session_connect( osrf_app_session* );
135 /** Sends a disconnect message to the remote service. No response is expected */
136 int osrf_app_session_disconnect( osrf_app_session* );
138 /** Waits up to 'timeout' seconds for some data to arrive.
139 * Any data that arrives will be processed according to its
140 * payload and message type. This method will return after
141 * any data has arrived.
143 int osrf_app_session_queue_wait( osrf_app_session*, int timeout );
145 /** Disconnects (if client), frees any attached app_reuqests, removes the session from the
146 * global session cache and frees the session. Needless to say, only call this when the
147 * session is completey done.
149 void osrf_app_session_destroy ( osrf_app_session* );
153 // --------------------------------------------------------------------------
154 // --------------------------------------------------------------------------
156 // --------------------------------------------------------------------------
158 /** Allocations and initializes a new app_request object */
159 osrf_app_request* _osrf_app_request_init( osrf_app_session* session, osrf_message* msg );
161 /** Frees memory used by an app_request object */
162 void _osrf_app_request_free( osrf_app_request * req );
164 /** Pushes the given message onto the list of 'responses' to this request */
165 void _osrf_app_request_push_queue( osrf_app_request*, osrf_message* payload );
167 /** Checks the receive queue for messages. If any are found, the first
168 * is popped off and returned. Otherwise, this method will wait at most timeout
169 * seconds for a message to appear in the receive queue. Once it arrives it is returned.
170 * If no messages arrive in the timeout provided, null is returned.
172 osrf_message* _osrf_app_request_recv( osrf_app_request* req, int timeout );
174 /** Resend this requests original request message */
175 int _osrf_app_request_resend( osrf_app_request* req );
178 /* tells the request to reset it's wait timeout */
179 void osrf_app_session_request_reset_timeout( osrf_app_session* session, int req_id );
181 // --------------------------------------------------------------------------
182 // --------------------------------------------------------------------------
184 // --------------------------------------------------------------------------
186 /** Returns the app_request with the given thread_trace (request_id) */
187 osrf_app_request* _osrf_app_session_get_request( osrf_app_session*, int thread_trace );
189 /** frees memory held by a session. Note: We delete all requests in the request list */
190 void _osrf_app_session_free( osrf_app_session* );
192 /** adds a session to the global session cache */
193 void _osrf_app_session_push_session( osrf_app_session* );
195 /** removes from global session cache */
196 void _osrf_app_session_remove_session( char* session_id );
198 /** Adds an app_request to the request set */
199 void _osrf_app_session_push_request( osrf_app_session*, osrf_app_request* req );
201 /** Removes an app_request from this session request set, freeing the request object */
202 void _osrf_app_session_remove_request( osrf_app_session*, osrf_app_request* req );
204 /** Send the given message */
205 int _osrf_app_session_send( osrf_app_session*, osrf_message* msg );