LP#1485371: Use client-supplied TZ
[OpenSRF.git] / include / opensrf / osrf_app_session.h
1 /**
2         @file osrf_app_session.h
3         @brief Header for osrfAppSession.
4 */
5
6 #ifndef OSRF_APP_SESSION_H
7 #define OSRF_APP_SESSION_H
8
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"
17
18 #ifdef __cplusplus
19 extern "C" {
20 #endif
21
22 enum OSRF_SESSION_STATE {
23         OSRF_SESSION_CONNECTING,
24         OSRF_SESSION_CONNECTED,
25         OSRF_SESSION_DISCONNECTED
26 };
27
28 enum OSRF_SESSION_TYPE {
29         OSRF_SESSION_SERVER,
30         OSRF_SESSION_CLIENT
31 };
32
33 struct osrf_app_request_struct;
34 typedef struct osrf_app_request_struct osrfAppRequest;
35
36 #define OSRF_REQUEST_HASH_SIZE 64
37
38 /**
39         @brief Representation of a session with another application.
40
41         An osrfAppSession is a list of lists.  It includes a list of osrfAppRequests
42         representing outstanding requests.  Each osrfAppRequest includes a list of
43         responses.
44 */
45 struct osrf_app_session_struct {
46
47         /** Our message passing object */
48         transport_client* transport_handle;
49
50         /** The original remote id of the remote service we're talking to */
51         char* orig_remote_id;
52         /** The current remote id of the remote service we're talking to */
53         char* remote_id;
54
55         /** Whom we're talking to if we're a client;
56                 what app we're serving if we're a server */
57         char* remote_service;
58
59         /** The current request thread_trace */
60         int thread_trace;
61         /** Our ID */
62         char* session_id;
63
64         /** Boolean; true if this session does not require connect messages.
65             Assigned a value depending on the compile-time macro ASSUME_STATELESS. */
66         int stateless;
67
68         /** The connect state */
69         enum OSRF_SESSION_STATE state;
70
71         /** SERVER or CLIENT */
72         enum OSRF_SESSION_TYPE type;
73
74         /** the current locale for this session. **/
75         char* session_locale;
76
77         /** the current TZ for this session. **/
78         char* session_tz;
79
80         /** let the user use the session to store their own session data. */
81         void* userData;
82
83         /** Callback function for freeing user's session data. */
84         void (*userDataFree) (void*);
85
86         int transport_error;
87
88         /** Hash table of pending requests. */
89         osrfAppRequest* request_hash[ OSRF_REQUEST_HASH_SIZE ];
90
91         /** Boolean: true if the app wants to terminate the process.  Typically this means that */
92         /** a drone has lost its database connection and can therefore no longer function.      */
93         int panic;
94
95         /** Buffer used by server drone to collect outbound response messages */
96         growing_buffer* outbuf;
97 };
98 typedef struct osrf_app_session_struct osrfAppSession;
99
100 // --------------------------------------------------------------------------
101 // PUBLIC API ***
102 // --------------------------------------------------------------------------
103
104 osrfAppSession* osrfAppSessionClientInit( const char* remote_service );
105
106 osrfAppSession* osrf_app_server_session_init(
107                 const char* session_id, const char* our_app, const char* remote_id );
108
109 char* osrf_app_session_set_locale( osrfAppSession*, const char* );
110
111 char* osrf_app_session_set_tz( osrfAppSession*, const char* );
112
113 /* ingress used by all sessions until replaced */
114 char* osrfAppSessionSetIngress( const char* );
115
116 const char* osrfAppSessionGetIngress();
117
118 osrfAppSession* osrf_app_session_find_session( const char* session_id );
119
120 /* DEPRECATED; use osrfAppSessionSendRequest() instead. */
121 int osrfAppSessionMakeRequest(
122                 osrfAppSession* session, const jsonObject* params,
123                 const char* method_name, int protocol, osrfStringArray* param_strings);
124
125 int osrfAppSessionSendRequest(
126                  osrfAppSession* session, const jsonObject* params,
127                  const char* method_name, int protocol );
128
129 void osrf_app_session_set_complete( osrfAppSession* session, int request_id );
130
131 int osrf_app_session_request_complete( const osrfAppSession* session, int request_id );
132
133 osrfMessage* osrfAppSessionRequestRecv(
134                 osrfAppSession* session, int request_id, int timeout );
135
136 void osrf_app_session_request_finish( osrfAppSession* session, int request_id );
137
138 int osrf_app_session_request_resend( osrfAppSession*, int request_id );
139
140 int osrfSendTransportPayload( osrfAppSession* session, const char* payload );
141
142 void osrf_app_session_reset_remote( osrfAppSession* );
143
144 void osrf_app_session_set_remote( osrfAppSession* session, const char* remote_id );
145
146 void osrf_app_session_push_queue( osrfAppSession*, osrfMessage* msg );
147
148 int osrfAppSessionConnect( osrfAppSession* );
149
150 int osrf_app_session_disconnect( osrfAppSession* );
151
152 int osrf_app_session_queue_wait( osrfAppSession*, int timeout, int* recvd );
153
154 void osrfAppSessionFree( osrfAppSession* );
155
156 void osrf_app_session_request_reset_timeout( osrfAppSession* session, int req_id );
157
158 int osrfAppRequestRespond( osrfAppSession* ses, int requestId, const jsonObject* data );
159
160 int osrfAppRequestRespondComplete(
161                 osrfAppSession* ses, int requestId, const jsonObject* data );
162
163 int osrfAppSessionStatus( osrfAppSession* ses, int type,
164                 const char* name, int reqId, const char* message );
165
166 void osrfAppSessionCleanup( void );
167
168 void osrfAppSessionPanic( osrfAppSession* ses );
169
170 #ifdef __cplusplus
171 }
172 #endif
173
174 #endif