1785adfc1f50c9568849ecc8a40f7e2a6b30f883
[OpenSRF.git] / include / opensrf / osrf_message.h
1 #ifndef osrf_message_h
2 #define osrf_message_h
3
4 /**
5         @file osrf_message.h
6         @brief Header for osrfMessage
7
8         An osrfMessage is the in-memory representation of a message between applications.
9
10         For transmission, one or more messages are encoded in a JSON array and wrapped in a
11         transport_message, which (together with its JSON cargo) is translated into XML as
12         a Jabber message.
13
14         There are five kinds of messages:
15         - CONNECT -- request to establish a stateful session.
16         - DISCONNECT -- ends a stateful session.
17         - REQUEST -- a remote procedure call.
18         - RESULT -- data returned by a remote procedure call.
19         - STATUS -- reports the success or failure of a requested operation.
20
21         Different kinds of messages use different combinations of the members of an osrfMessage.
22 */
23
24 #include <opensrf/string_array.h>
25 #include <opensrf/utils.h>
26 #include <opensrf/log.h>
27 #include <opensrf/osrf_json.h>
28
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32
33 #define OSRF_XML_NAMESPACE "http://open-ils.org/xml/namespaces/oils_v1"
34
35 #define OSRF_STATUS_CONTINUE             100
36
37 #define OSRF_STATUS_OK                   200
38 #define OSRF_STATUS_ACCEPTED             202
39 #define OSRF_STATUS_COMPLETE             205
40
41 #define OSRF_STATUS_PARTIAL              206
42 #define OSRF_STATUS_NOCONTENT            204
43
44 #define OSRF_STATUS_REDIRECTED           307
45
46 #define OSRF_STATUS_BADREQUEST           400
47 #define OSRF_STATUS_UNAUTHORIZED         401
48 #define OSRF_STATUS_FORBIDDEN            403
49 #define OSRF_STATUS_NOTFOUND             404
50 #define OSRF_STATUS_NOTALLOWED           405
51 #define OSRF_STATUS_TIMEOUT              408
52 #define OSRF_STATUS_EXPFAILED            417
53
54 #define OSRF_STATUS_INTERNALSERVERERROR  500
55 #define OSRF_STATUS_NOTIMPLEMENTED       501
56 #define OSRF_STATUS_VERSIONNOTSUPPORTED  505
57
58
59 enum M_TYPE { CONNECT, REQUEST, RESULT, STATUS, DISCONNECT };
60
61 struct osrf_message_struct {
62
63         /** One of the four message types: CONNECT, REQUEST, RESULT, STATUS, or DISCONNECT. */
64         enum M_TYPE m_type;
65         
66         /** Used to keep track of which responses go with which requests. */
67         int thread_trace;
68         
69         /** Currently serves no discernible purpose, but may be useful someday. */
70         int protocol;
71
72         /** Used for STATUS or RESULT messages. */
73         char* status_name;
74
75         /** Used for STATUS or RESULT messages. */
76         char* status_text;
77
78         /** Used for STATUS or RESULT messages. */
79         int status_code;
80
81         /** Boolean: true for some kinds of error conditions. */
82         int is_exception;
83
84         /** Used for RESULT messages: contains the data returned by a remote procedure. */
85         jsonObject* _result_content;
86
87         /** For a REQUEST message: name of the remote procedure to call. */
88         char* method_name;
89
90         /** For a REQUEST message: parameters to pass to the remote procedure call. */
91         jsonObject* _params;
92
93         /** Pointer for linked lists.  Used only by calling code. */
94         struct osrf_message_struct* next;
95
96         /** Magical LOCALE hint. */
97         char* sender_locale;
98
99         /** Magical ingress hint. */
100         char* sender_ingress;
101
102         /** Magical TZ hint. */
103         char* sender_tz;
104 };
105 typedef struct osrf_message_struct osrfMessage;
106
107 const char* osrf_message_set_locale( osrfMessage* msg, const char* locale );
108
109 const char* osrf_message_set_tz( osrfMessage* msg, const char* tz );
110
111 const char* osrfMessageSetIngress( osrfMessage* msg, const char* ingress );
112
113 const char* osrf_message_set_default_locale( const char* locale );
114
115 const char* osrf_message_get_last_locale(void);
116
117 const char* osrf_message_get_last_tz(void);
118
119 osrfMessage* osrf_message_init( enum M_TYPE type, int thread_trace, int protocol );
120
121 void osrf_message_set_status_info( osrfMessage*,
122                 const char* status_name, const char* status_text, int status_code );
123
124 void osrf_message_set_result_content( osrfMessage*, const char* json_string );
125
126 void osrf_message_set_result( osrfMessage* msg, const jsonObject* obj );
127
128 void osrfMessageFree( osrfMessage* );
129
130 char* osrf_message_to_xml( osrfMessage* );
131
132 jsonObject* osrfMessageToJSON( const osrfMessage* msg );
133
134 char* osrf_message_serialize(const osrfMessage*);
135
136 osrfList* osrfMessageDeserialize( const char* string, osrfList* list );
137
138 int osrf_message_deserialize(const char* json, osrfMessage* msgs[], int count);
139
140 void osrf_message_set_params( osrfMessage* msg, const jsonObject* o );
141
142 void osrf_message_set_method( osrfMessage* msg, const char* method_name );
143
144 void osrf_message_add_object_param( osrfMessage* msg, const jsonObject* o );
145
146 void osrf_message_add_param( osrfMessage*, const char* param_string );
147
148 const jsonObject* osrfMessageGetResult( osrfMessage* msg );
149
150 char* osrfMessageSerializeBatch( osrfMessage* msgs [], int count );
151
152 #ifdef __cplusplus
153 }
154 #endif
155
156 #endif