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 };
  79 typedef struct osrf_message_struct osrf_message;
  80 typedef struct osrf_message_struct osrfMessage;
  81
  82
  83 osrf_message* osrf_message_init( enum M_TYPE type, int thread_trace, int protocol );
  84 //void osrf_message_set_request_info( osrf_message*, char* param_name, json* params );
  85 void osrf_message_set_status_info( osrf_message*, char* status_name, char* status_text, int status_code );
  86 void osrf_message_set_result_content( osrf_message*, char* json_string );
  87 void osrfMessageFree( osrfMessage* );
  88 void osrf_message_free( osrf_message* );
  89 char* osrf_message_to_xml( osrf_message* );
  90 char* osrf_message_serialize(osrf_message*);
  91
  92 /* count is the max number of messages we'll put into msgs[] */
  93 int osrf_message_deserialize(char* json, osrf_message* msgs[], int count);
  94
  95
  96
  97 /** Pushes any message retreived from the xml into the 'msgs' array.
  98   * it is assumed that 'msgs' has beenn pre-allocated.
  99   * Returns the number of message that are in the buffer.
 100   */
 101 int osrf_message_from_xml( char* xml, osrf_message* msgs[] );
 102
 103 void osrf_message_set_params( osrf_message* msg, jsonObject* o );
 104 void osrf_message_set_method( osrf_message* msg, char* method_name );
 105 void osrf_message_add_object_param( osrf_message* msg, jsonObject* o );
 106 void osrf_message_add_param( osrf_message*, char* param_string );
 107
 108
 109 jsonObject* osrfMessageGetResult( osrfMessage* msg );
 110
 111 /**
 112   Returns the message as a jsonObject
 113   @return The jsonObject which must be freed by the caller.
 114   */
 115 jsonObject* osrfMessageToJSON( osrfMessage* msg );
 116
 117 char* osrfMessageSerializeBatch( osrfMessage* msgs [], int count );
 118
 119
 120 #endif