Eliminated the obsolete function osrf_message_free(), which is now
[OpenSRF.git] / include / opensrf / osrf_message.h
1 #include <opensrf/string_array.h>
2 #include <opensrf/utils.h>
3 #include <opensrf/log.h>
4 #include <opensrf/osrf_json.h>
5
6
7 /* libxml stuff for the config reader */
8 #include <libxml/xmlmemory.h>
9 #include <libxml/parser.h>
10 #include <libxml/xpath.h>
11 #include <libxml/xpathInternals.h>
12 #include <libxml/tree.h>
13
14
15
16 #ifndef osrf_message_h
17 #define osrf_message_h
18
19 #define OSRF_XML_NAMESPACE "http://open-ils.org/xml/namespaces/oils_v1"
20
21 #define OSRF_STATUS_CONTINUE                                            100
22
23 #define OSRF_STATUS_OK                                                          200
24 #define OSRF_STATUS_ACCEPTED                                            202
25 #define OSRF_STATUS_COMPLETE                                            205
26
27 #define OSRF_STATUS_REDIRECTED                                  307
28
29 #define OSRF_STATUS_BADREQUEST                                  400
30 #define OSRF_STATUS_UNAUTHORIZED                                        401
31 #define OSRF_STATUS_FORBIDDEN                                           403
32 #define OSRF_STATUS_NOTFOUND                                            404
33 #define OSRF_STATUS_NOTALLOWED                                  405
34 #define OSRF_STATUS_TIMEOUT                                             408
35 #define OSRF_STATUS_EXPFAILED                                           417
36
37 #define OSRF_STATUS_INTERNALSERVERERROR         500
38 #define OSRF_STATUS_NOTIMPLEMENTED                              501
39 #define OSRF_STATUS_VERSIONNOTSUPPORTED         505
40
41
42 enum M_TYPE { CONNECT, REQUEST, RESULT, STATUS, DISCONNECT };
43
44 #define OSRF_MAX_PARAMS                                                         128;
45
46 struct osrf_message_struct {
47
48         enum M_TYPE m_type;
49         int thread_trace;
50         int protocol;
51
52         /* if we're a STATUS message */
53         char* status_name;
54
55         /* if we're a STATUS or RESULT */
56         char* status_text;
57         int status_code;
58
59         int is_exception;
60
61         /* if we're a RESULT */
62         jsonObject* _result_content;
63
64         /* unparsed json string */
65         char* result_string;
66
67         /* if we're a REQUEST */
68         char* method_name;
69
70         jsonObject* _params;
71
72         /* in case anyone wants to make a list of us.  
73                 we won't touch this variable */
74         struct osrf_message_struct* next;
75
76         char* full_param_string;
77
78         /* magical LOCALE hint */
79         char* sender_locale;
80
81         /* timezone offset from GMT of sender, in seconds */
82         int sender_tz_offset;
83
84 };
85 typedef struct osrf_message_struct osrfMessage;
86
87 /* Set the locale hint for this message.
88    default_locale is used if not set.
89    Returns NULL if msg or locale is not set, char* to msg->sender_locale on success.
90 */
91 char* osrf_message_set_locale( osrfMessage* msg, const char* locale );
92
93 /* Set the default locale hint to be used for future outgoing messages.
94    Returns NULL if locale is NULL, const char* to default_locale otherwise.
95 */
96 const char* osrf_message_set_default_locale( const char* locale );
97
98 /* Get the current locale hint -- either the default or most recently received locale.
99    Returns const char* to current_locale.
100 */
101 const char* osrf_message_get_last_locale(void);
102
103 osrfMessage* osrf_message_init( enum M_TYPE type, int thread_trace, int protocol );
104 //void osrf_message_set_request_info( osrfMessage*, char* param_name, json* params );
105 void osrf_message_set_status_info( osrfMessage*,
106                 const char* status_name, const char* status_text, int status_code );
107 void osrf_message_set_result_content( osrfMessage*, const char* json_string );
108 void osrfMessageFree( osrfMessage* );
109 char* osrf_message_to_xml( osrfMessage* );
110 char* osrf_message_serialize(const osrfMessage*);
111
112 /* count is the max number of messages we'll put into msgs[] */
113 int osrf_message_deserialize(const char* json, osrfMessage* msgs[], int count);
114
115
116
117 /** Pushes any message retreived from the xml into the 'msgs' array.
118   * it is assumed that 'msgs' has beenn pre-allocated.
119   * Returns the number of message that are in the buffer.
120   */
121 int osrf_message_from_xml( char* xml, osrfMessage* msgs[] );
122
123 void osrf_message_set_params( osrfMessage* msg, const jsonObject* o );
124 void osrf_message_set_method( osrfMessage* msg, const char* method_name );
125 void osrf_message_add_object_param( osrfMessage* msg, const jsonObject* o );
126 void osrf_message_add_param( osrfMessage*, const char* param_string );
127
128
129 jsonObject* osrfMessageGetResult( osrfMessage* msg );
130
131 /**
132   Returns the message as a jsonObject
133   @return The jsonObject which must be freed by the caller.
134   */
135 jsonObject* osrfMessageToJSON( const osrfMessage* msg );
136
137 char* osrfMessageSerializeBatch( osrfMessage* msgs [], int count );
138
139
140 #endif