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 /* entry point for data into the stack. gets set in osrf_stack.c */
21 int (*osrf_stack_entry_point) (transport_client* client, int timeout );
23 struct osrf_app_request_struct {
24 /** Our controlling session */
25 struct osrf_app_session_struct* session;
29 /** True if we have received a 'request complete' message from our request */
31 /** Our original request payload */
32 osrf_message* payload;
33 /** List of responses to our request */
36 /* if set to true, then a call that is waiting on a response, will reset the
37 timeout and set this variable back to false */
40 /** So we can be listified */
41 struct osrf_app_request_struct* next;
43 typedef struct osrf_app_request_struct osrf_app_request;
45 struct osrf_app_session_struct {
47 /** Our messag passing object */
48 transport_client* transport_handle;
49 /** Cache of active app_request objects */
50 osrf_app_request* request_queue;
52 /** The original remote id of the remote service we're talking to */
54 /** The current remote id of the remote service we're talking to */
57 /** Who we're talking to */
60 /** The current request thread_trace */
65 /* true if this session does not require connect messages */
68 /** The connect state */
69 enum OSRF_SESSION_STATE state;
71 /** SERVER or CLIENT */
72 enum OSRF_SESSION_TYPE type;
74 /** So we can be listified */
75 struct osrf_app_session_struct* next;
78 typedef struct osrf_app_session_struct osrf_app_session;
82 // --------------------------------------------------------------------------
84 // --------------------------------------------------------------------------
86 /** Allocates a initializes a new app_session */
87 osrf_app_session* osrf_app_client_session_init( char* remote_service );
89 /** Allocates and initializes a new server session. The global session cache
90 * is checked to see if this session already exists, if so, it's returned
92 osrf_app_session* osrf_app_server_session_init(
93 char* session_id, char* our_app, char* remote_service, char* remote_id );
95 /** returns a session from the global session hash */
96 osrf_app_session* osrf_app_session_find_session( char* session_id );
98 /** Builds a new app_request object with the given payload andn returns
99 * the id of the request. This id is then used to perform work on the
102 int osrf_app_session_make_req(
103 osrf_app_session* session, object* params,
104 char* method_name, int protocol, string_array* param_strings);
106 /** Sets the given request to complete state */
107 void osrf_app_session_set_complete( osrf_app_session* session, int request_id );
109 /** Returns true if the given request is complete */
110 int osrf_app_session_request_complete( osrf_app_session* session, int request_id );
112 /** Does a recv call on the given request */
113 osrf_message* osrf_app_session_request_recv(
114 osrf_app_session* session, int request_id, int timeout );
116 /** Removes the request from the request set and frees the reqest */
117 void osrf_app_session_request_finish( osrf_app_session* session, int request_id );
119 /** Resends the orginal request with the given request id */
120 int osrf_app_session_request_resend( osrf_app_session*, int request_id );
122 /** Resets the remote connection target to that of the original*/
123 void osrf_app_session_reset_remote( osrf_app_session* );
125 /** Sets the remote target to 'remote_id' */
126 void osrf_app_session_set_remote( osrf_app_session* session, char* remote_id );
128 /** pushes the given message into the result list of the app_request
129 * whose request_id matches the messages thread_trace
131 int osrf_app_session_push_queue( osrf_app_session*, osrf_message* msg );
133 /** Attempts to connect to the remote service. Returns 1 on successful
134 * connection, 0 otherwise.
136 int osrf_app_session_connect( osrf_app_session* );
138 /** Sends a disconnect message to the remote service. No response is expected */
139 int osrf_app_session_disconnect( osrf_app_session* );
141 /** Waits up to 'timeout' seconds for some data to arrive.
142 * Any data that arrives will be processed according to its
143 * payload and message type. This method will return after
144 * any data has arrived.
146 int osrf_app_session_queue_wait( osrf_app_session*, int timeout );
148 /** Disconnects (if client), frees any attached app_reuqests, removes the session from the
149 * global session cache and frees the session. Needless to say, only call this when the
150 * session is completey done.
152 void osrf_app_session_destroy ( osrf_app_session* );
156 // --------------------------------------------------------------------------
157 // --------------------------------------------------------------------------
159 // --------------------------------------------------------------------------
161 /** Allocations and initializes a new app_request object */
162 osrf_app_request* _osrf_app_request_init( osrf_app_session* session, osrf_message* msg );
164 /** Frees memory used by an app_request object */
165 void _osrf_app_request_free( osrf_app_request * req );
167 /** Pushes the given message onto the list of 'responses' to this request */
168 void _osrf_app_request_push_queue( osrf_app_request*, osrf_message* payload );
170 /** Checks the receive queue for messages. If any are found, the first
171 * is popped off and returned. Otherwise, this method will wait at most timeout
172 * seconds for a message to appear in the receive queue. Once it arrives it is returned.
173 * If no messages arrive in the timeout provided, null is returned.
175 osrf_message* _osrf_app_request_recv( osrf_app_request* req, int timeout );
177 /** Resend this requests original request message */
178 int _osrf_app_request_resend( osrf_app_request* req );
181 /* tells the request to reset it's wait timeout */
182 void osrf_app_session_request_reset_timeout( osrf_app_session* session, int req_id );
184 // --------------------------------------------------------------------------
185 // --------------------------------------------------------------------------
187 // --------------------------------------------------------------------------
189 /** Returns the app_request with the given thread_trace (request_id) */
190 osrf_app_request* _osrf_app_session_get_request( osrf_app_session*, int thread_trace );
192 /** frees memory held by a session. Note: We delete all requests in the request list */
193 void _osrf_app_session_free( osrf_app_session* );
195 /** adds a session to the global session cache */
196 void _osrf_app_session_push_session( osrf_app_session* );
198 /** removes from global session cache */
199 void _osrf_app_session_remove_session( char* session_id );
201 /** Adds an app_request to the request set */
202 void _osrf_app_session_push_request( osrf_app_session*, osrf_app_request* req );
204 /** Removes an app_request from this session request set, freeing the request object */
205 void _osrf_app_session_remove_request( osrf_app_session*, osrf_app_request* req );
207 /** Send the given message */
208 int _osrf_app_session_send( osrf_app_session*, osrf_message* msg );