OpenSRF/src/libtransport/transport_client.h

   1 #include "transport_session.h"
   2 #include "utils.h"
   3 #include "logging.h"
   4
   5 #include <time.h>
   6
   7 #ifndef TRANSPORT_CLIENT_H
   8 #define TRANSPORT_CLIENT_H
   9
  10 #define MESSAGE_LIST_HEAD 1
  11 #define MESSAGE_LIST_ITEM 2
  12
  13
  14 // ---------------------------------------------------------------------------
  15 // Represents a node in a linked list.  The node holds a pointer to the next
  16 // node (which is null unless set), a pointer to a transport_message, and
  17 // and a type variable (which is not really curently necessary).
  18 // ---------------------------------------------------------------------------
  19 struct message_list_struct {
  20         struct message_list_struct* next;
  21         transport_message* message;
  22         int type;
  23 };
  24
  25 typedef struct message_list_struct transport_message_list;
  26 typedef struct message_list_struct transport_message_node;
  27
  28 // ---------------------------------------------------------------------------
  29 // Our client struct.  We manage a list of messages and a controlling session
  30 // ---------------------------------------------------------------------------
  31 struct transport_client_struct {
  32         transport_message_list* m_list;
  33         transport_session* session;
  34 };
  35 typedef struct transport_client_struct transport_client;
  36
  37 // ---------------------------------------------------------------------------
  38 // Allocates and initializes and transport_client.  This does no connecting
  39 // The user must call client_free(client) when finished with the allocated
  40 // object.
  41 // ---------------------------------------------------------------------------
  42 transport_client* client_init( char* server, int port, int component );
  43
  44
  45 // ---------------------------------------------------------------------------
  46 // Connects to the Jabber server with the provided information. Returns 1 on
  47 // success, 0 otherwise.
  48 // ---------------------------------------------------------------------------
  49 int client_connect( transport_client* client,
  50                 char* username, char* password, char* resource,
  51                 int connect_timeout, enum TRANSPORT_AUTH_TYPE auth_type );
  52
  53
  54 int client_disconnect( transport_client* client );
  55
  56 // ---------------------------------------------------------------------------
  57 // De-allocates memory associated with a transport_client object.  Users
  58 // must use this method when finished with a client object.
  59 // ---------------------------------------------------------------------------
  60 int client_free( transport_client* client );
  61
  62 // ---------------------------------------------------------------------------
  63 //  Sends the given message.  The message must at least have the recipient
  64 // field set.
  65 // ---------------------------------------------------------------------------
  66 int client_send_message( transport_client* client, transport_message* msg );
  67
  68 // ---------------------------------------------------------------------------
  69 // Returns 1 if this client is currently connected to the server, 0 otherwise
  70 // ---------------------------------------------------------------------------
  71 int client_connected( transport_client* client );
  72
  73 // ---------------------------------------------------------------------------
  74 // This is the message handler required by transport_session.  This handler
  75 // takes all incoming messages and puts them into the back of a linked list
  76 // of messages.
  77 // ---------------------------------------------------------------------------
  78 void client_message_handler( void* client, transport_message* msg );
  79
  80 // ---------------------------------------------------------------------------
  81 // If there are any message in the message list, the 'oldest' message is
  82 // returned.  If not, this function will wait at most 'timeout' seconds
  83 // for a message to arrive.  Specifying -1 means that this function will not
  84 // return unless a message arrives.
  85 // ---------------------------------------------------------------------------
  86 transport_message* client_recv( transport_client* client, int timeout );
  87
  88
  89 #endif