CallbackServerUnparsed.h

Go to the documentation of this file.

/*----------------------------------------------------------------------------
Name:      CallbackServerUnparsed.h
Project:   xmlBlaster.org
Copyright: xmlBlaster.org, see xmlBlaster-LICENSE file
Comment:   Include this header in your client code if you want to establish
           a client side callback server.
           We will call the update() method when messages arrive.
           The received message key and QoS is not parsed, we need another
           layer doing XML parsing with expat.
           This library is thread safe, multiple client callback servers may
           be established in parallel.
Author:    "Marcel Ruff" <xmlBlaster@marcelruff.info>
Date:      05/2003
See:       http://www.xmlblaster.org/xmlBlaster/doc/requirements/interface.html
-----------------------------------------------------------------------------*/
#ifndef XMLBLASTER_CallbackServerUnparsed_H
#define XMLBLASTER_CallbackServerUnparsed_H

#ifdef __cplusplus
#ifndef XMLBLASTER_C_COMPILE_AS_CPP /* 'g++ -DXMLBLASTER_C_COMPILE_AS_CPP ...' allows to compile the lib as C++ code */
extern "C" {
#endif
#endif

#include <util/msgUtil.h>
#include <util/Properties.h>
#include "socket/xmlBlasterSocket.h"

#define DEFAULT_CALLBACK_SERVER_PORT 7611

/* Forward declarations */
struct SocketDataHolder;
struct CallbackServerUnparsedStruct;
typedef struct CallbackServerUnparsedStruct CallbackServerUnparsed;

/* Define function pointers */

typedef bool (* UseThisSocket)(CallbackServerUnparsed *cb, int socketToUse, int socketToUseUdp);

typedef int (* InitCallbackServer)(CallbackServerUnparsed *cb);

typedef bool (* IsListening)(CallbackServerUnparsed *cb);

typedef void (*UpdateCbFp)(MsgUnitArr *msg, void *userData, XmlBlasterException *xmlBlasterException, void/*SocketDataHolder*/ *socketDataHolder);

typedef void (* ShutdownCallbackServerRaw)(CallbackServerUnparsed *cb);

typedef void ( * CallbackServerUnparsedSendResponse)(CallbackServerUnparsed *cb, void/*SocketDataHolder*/ *socketDataHolder, MsgUnitArr *msgUnitArr);
typedef void ( * CallbackServerUnparsedSendXmlBlasterException)(CallbackServerUnparsed *cb, void/*SocketDataHolder*/ *socketDataHolder, XmlBlasterException *exception);
typedef void ( * CallbackServerUnparsedDoRespond)(bool success, CallbackServerUnparsed *cb, void/*SocketDataHolder*/ *socketDataHolder, MsgUnitArr *msgUnitArrP, XmlBlasterException *exception);

#define MAX_RESPONSE_LISTENER_SIZE 100

typedef void (* ResponseFp)(MsgRequestInfo *msgRequestInfoP, void /*SocketDataHolder*/ *socketDataHolder); /* using void * to avoid including the socket specific header */

typedef struct ResponseListenerStruct {
   MsgRequestInfo *msgRequestInfoP;
   /*void *userP;
   const char *requestId;*/
   ResponseFp responseEventFp;
} ResponseListener;

typedef bool ( * AddResponseListener)(CallbackServerUnparsed *cb, MsgRequestInfo *msgRequestInfoP, ResponseFp responseEventFp);
typedef ResponseListener * ( * RemoveResponseListener)(CallbackServerUnparsed *cb, const char *requestId);

typedef void  ( * CallbackServerUnparsedLogging)(void *logUserP, XMLBLASTER_LOG_LEVEL currLevel, XMLBLASTER_LOG_LEVEL level, const char *location, const char *fmt, ...);

struct CallbackServerUnparsedStruct {
   Properties *props;
   bool stopListenLoop;
   int listenSocket;
   int acceptSocket;
   int socketUdp;
   char * hostCB;
   int portCB;
   bool reusingConnectionSocket; 
   XMLBLASTER_LOG_LEVEL logLevel;
   CallbackServerUnparsedLogging log;
   void *logUserP;               
   /*
    * Is created by the client and used to validate callback messages in update. 
    * This is sent on connect in ConnectQos.
    * (Is different from the xmlBlaster secret session ID)
   char secretSessionId[MAX_SECRETSESSIONID_LEN];
   */
   InitCallbackServer runCallbackServer;
   IsListening isListening;
   ShutdownCallbackServerRaw shutdown; 
   UpdateCbFp updateCb;
   void *updateCbUserData; 
   UseThisSocket useThisSocket;
   ResponseListener responseListener[MAX_RESPONSE_LISTENER_SIZE];
   AddResponseListener addResponseListener;
   RemoveResponseListener removeResponseListener;
   bool isShutdown;
   CallbackServerUnparsedSendResponse sendResponse;
   CallbackServerUnparsedSendXmlBlasterException sendXmlBlasterException;
   CallbackServerUnparsedDoRespond sendResponseOrException;
   pthread_mutex_t listenMutex;

   /* Socket write access: */
   XmlBlasterWriteToSocketFuncHolder writeToSocket;  
   /* Socket read access: */
   XmlBlasterReadFromSocketFuncHolder readFromSocket; 
};

typedef struct ListenLoopArgsStruct {
   CallbackServerUnparsed* cb;
   bool udp;
} ListenLoopArgs;

extern CallbackServerUnparsed *getCallbackServerUnparsed(int argc, const char* const* argv,
                               UpdateCbFp updateCb, void *userData);

extern void freeCallbackServerUnparsed(CallbackServerUnparsed **callbackData);

extern const char *callbackServerRawUsage();

typedef void * (*cbFp)(void *);


#ifdef __cplusplus
#ifndef XMLBLASTER_C_COMPILE_AS_CPP
}
#endif
#endif

#endif /* XMLBLASTER_CallbackServerUnparsed_H */