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