src/router/router.h

   1 #include "opensrf/transport_client.h"
   2 #include "opensrf/transport_message.h"
   3 #include "opensrf/osrf_message.h"
   4
   5 #include "utils.h"
   6 #include "logging.h"
   7 #include "osrf_config.h"
   8
   9 #include <time.h>
  10 #include <sys/select.h>
  11
  12 #ifndef ROUTER_H
  13 #define ROUTER_H
  14
  15 #define ROUTER_MAX_TRUSTED 256
  16
  17 // ----------------------------------------------------------------------
  18 // Jabber router_registrar/load balancer.  There is a top level linked list of
  19 // server_class_nodes.  A server class represents the a cluster of Jabber
  20 // clients that define a single logical routing endpoint.  Each of these
  21 // server_class_nodes maintains a list of connected server_nodes, which
  22 // represents the pool of connected server endpoints.  A request
  23 // directed at a particular class is routed to the next available
  24 // server endpoint.
  25 //
  26 // ----------------------------------------------------------------------
  27
  28
  29 // ----------------------------------------------------------------------
  30 // Defines an element in a server list.  The server list is a circular
  31 // doubly linked list.  User is responsible for freeing a server_node with
  32 // server_node_free()
  33 // ----------------------------------------------------------------------
  34 struct server_node_struct {
  35
  36         struct server_node_struct* next;
  37         struct server_node_struct* prev;
  38
  39         time_t la_time; /* last time we sent a message to a server */
  40         time_t reg_time;        /* time we originally registered */
  41         time_t upd_time;        /* last re-register time */
  42         int available;          /* true if we may be used */
  43
  44         int serve_count; /* how many messages we've sent */
  45
  46         /* jabber remote id  for this server node*/
  47         char* remote_id;
  48
  49         /* we cache the last sent message in case our remote
  50                 endpoint has gone away.  If it has, the next server
  51                 node in the list will re-send our last message */
  52         transport_message* last_sent;
  53
  54 };
  55 typedef struct server_node_struct server_node;
  56
  57
  58 // ----------------------------------------------------------------------
  59 // Models a basic jabber connection structure.  Any component that
  60 // connects to jabber will have one of these.
  61 // ----------------------------------------------------------------------
  62 struct jabber_connect_struct {
  63
  64         char* server;
  65         int port;
  66         char* username;
  67         char* password;
  68         char* resource;
  69         int connect_timeout;
  70
  71         transport_client* t_client;
  72 };
  73 typedef struct jabber_connect_struct jabber_connect;
  74
  75
  76
  77 // ----------------------------------------------------------------------
  78 // Defines an element in the list of server classes.  User is
  79 // responsible for freeing a server_class_node with
  80 // server_class_node_free().
  81 // The server_node_list is a doubly (not circular) linked list
  82 // ----------------------------------------------------------------------
  83 struct server_class_node_struct {
  84
  85         /* the name of our class.  This will be used as the jabber
  86          resource when we create a class level connection*/
  87         char* server_class;
  88
  89         /* the current node in the ring of available server nodes */
  90         server_node* current_server_node;
  91
  92         /* next and prev class_node pointers */
  93         struct server_class_node_struct* next;
  94         struct server_class_node_struct* prev;
  95
  96         /* our jabber connection struct */
  97         jabber_connect* jabber;
  98
  99 };
 100 typedef struct server_class_node_struct server_class_node;
 101
 102
 103 // ----------------------------------------------------------------------
 104 // Top level router_registrar object.  Maintains the list of
 105 // server_class_nodes and the top level router jabber connection.
 106 // ----------------------------------------------------------------------
 107 struct transport_router_registrar_struct {
 108
 109         /* the list of server class nodes */
 110         server_class_node* server_class_list;
 111
 112         /* if we don't hear from the client in this amount of time
 113                 we consider them dead... */
 114         /* not currently used */
 115         int client_timeout; /* seconds */
 116
 117         /* our top level connection to the jabber server */
 118         jabber_connect* jabber;
 119
 120         /* true if we connect to jabber as a jabber component */
 121         int component;
 122
 123         char** trusted_servers;
 124         char** trusted_clients;
 125
 126
 127 };
 128 typedef struct transport_router_registrar_struct transport_router_registrar;
 129
 130
 131 // ----------------------------------------------------------------------
 132 // Returns an allocated transport_router_registrar.  The user is responsible for
 133 // freeing the allocated memory with router_registrar_free()
 134 // client_timeout is unused at this time.
 135 // connect_timeout is how long we will wait for a failed jabber connect
 136 // attempt for the top level connection.
 137 // ----------------------------------------------------------------------
 138 transport_router_registrar* router_registrar_init( char* server,
 139                 int port, char* username, char* password, char* resource,
 140                 int client_timeout, int connect_timeout, int component );
 141
 142 // ----------------------------------------------------------------------
 143 // Connects the top level router_registrar object to the Jabber server.
 144 // ----------------------------------------------------------------------
 145 int router_registrar_connect( transport_router_registrar* router );
 146
 147 // ----------------------------------------------------------------------
 148 // Connects the given jabber_connect object to the Jabber server
 149 // ----------------------------------------------------------------------
 150 int j_connect( jabber_connect* jabber );
 151
 152
 153 // ----------------------------------------------------------------------
 154 // Builds and initializes a jabber_connect object. User is responsible
 155 // for freeing the memory with jabber_connect_free();
 156 // ----------------------------------------------------------------------
 157 jabber_connect* jabber_connect_init( char* server,
 158                 int port, char* username, char* password,
 159                 char* resource, int connect_timeout, int component );
 160
 161 // ----------------------------------------------------------------------
 162 // Allocates and initializes a server class instance.  This will be
 163 // called when a new class message arrives.  It will connect to Jabber
 164 // as router_registrar->username@router_registrar->server/new_class
 165 // ----------------------------------------------------------------------
 166 server_class_node* init_server_class(
 167                 transport_router_registrar* router_registrar, char* remote_id, char* server_class );
 168
 169 // ----------------------------------------------------------------------
 170 // Allocates and initializes a server_node object.  The object must
 171 // be freed with server_node_free().
 172 // remote_id is the full jabber login for the remote server connection
 173 // I.e. where we send messages when we want to send them to this
 174 // server.
 175 // ----------------------------------------------------------------------
 176 server_node* init_server_node(  char* remote_id );
 177
 178
 179 // ----------------------------------------------------------------------
 180 // Routes messages sent to the provided server_class_node's class
 181 // ----------------------------------------------------------------------
 182 int  server_class_handle_msg( transport_router_registrar* router,
 183                 server_class_node* s_node, transport_message* msg );
 184
 185 // ----------------------------------------------------------------------
 186 // Determines what to do with an inbound register/unregister message.
 187 // ----------------------------------------------------------------------
 188 int router_registrar_handle_msg( transport_router_registrar*, transport_message* msg );
 189
 190 // ----------------------------------------------------------------------
 191 // Deallocates the memory occupied by the given server_node
 192 // ----------------------------------------------------------------------
 193 int server_node_free( server_node* node );
 194
 195 // ----------------------------------------------------------------------
 196 // Deallocates the memory used by the given server_class_node.  This
 197 // will also free any attached server_node's.
 198 // ----------------------------------------------------------------------
 199 int server_class_node_free( server_class_node* node );
 200
 201 // ----------------------------------------------------------------------
 202 // Deallocates the memory used by a server_node
 203 // ----------------------------------------------------------------------
 204 int server_node_free( server_node* node );
 205
 206
 207 // ----------------------------------------------------------------------
 208 // Deallocates a jabber_connect node
 209 // ----------------------------------------------------------------------
 210 int jabber_connect_free( jabber_connect* jabber );
 211
 212 // ----------------------------------------------------------------------
 213 // Deallocates the memory used by the router_registrar.  This will also call
 214 // server_class_node_free on any attached server_class_nodes.
 215 // ----------------------------------------------------------------------
 216 int router_registrar_free( transport_router_registrar* router_registrar );
 217
 218
 219 // ----------------------------------------------------------------------
 220 //  Returns the server_node with the given Jabber remote_id
 221 // ----------------------------------------------------------------------
 222 server_node * find_server_node ( server_class_node * class, const char * remote_id );
 223
 224
 225 // ----------------------------------------------------------------------
 226 // Returns the server_class_node object with the given class_name
 227 // ----------------------------------------------------------------------
 228 server_class_node * find_server_class ( transport_router_registrar * router, const char * class_id );
 229
 230 // ----------------------------------------------------------------------
 231 // Removes a server class from the top level router_registrar
 232 // ----------------------------------------------------------------------
 233 int unregister_server_node( server_class_node* active_class_node, char* remote_id );
 234
 235 int fill_fd_set( transport_router_registrar* router, fd_set* set );
 236
 237 void listen_loop( transport_router_registrar* router );
 238
 239
 240 int router_return_server_info( transport_router_registrar* router, transport_message* msg );
 241
 242 int remove_server_class( transport_router_registrar* router, server_class_node* class );
 243
 244
 245
 246 int router_registrar_handle_app_request( transport_router_registrar*, transport_message* msg );
 247
 248 osrf_message** router_registrar_process_app_request(
 249                 transport_router_registrar* , osrf_message* omsg, int* num_responses );
 250
 251
 252 // ----------------------------------------------------------------------
 253 // Adds a handler for the SIGUSR1 that we send to wake all the
 254 // listening threads.
 255 // ----------------------------------------------------------------------
 256 //void sig_handler( int sig );
 257
 258 #endif