XmlBlasterAccessUnparsed.h File Reference

#include <util/msgUtil.h>
#include <util/Properties.h>
#include <XmlBlasterConnectionUnparsed.h>
#include <CallbackServerUnparsed.h>
#include <pthread.h>

Include dependency graph for XmlBlasterAccessUnparsed.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	XmlBlasterAccessUnparsed
	All client access to xmlBlaster goes over this struct and its function pointers. More...
Typedefs
typedef int(*)	UpdateFp (MsgUnitArr *msg, void *userData, XmlBlasterException *xmlBlasterException)
typedef char *(*)	XmlBlasterAccessUnparsedConnect (struct XmlBlasterAccessUnparsed *xb, const char *const qos, UpdateFp update, XmlBlasterException *exception)
typedef int(*)	XmlBlasterAccessUnparsedInitialize (struct XmlBlasterAccessUnparsed *xa, UpdateFp update, XmlBlasterException *exception)
typedef int(*)	XmlBlasterAccessUnparsedDisconnect (struct XmlBlasterAccessUnparsed *xb, const char *qos, XmlBlasterException *exception)
typedef char *(*)	XmlBlasterAccessUnparsedPublish (struct XmlBlasterAccessUnparsed *xb, MsgUnit *msgUnit, XmlBlasterException *exception)
typedef QosArr *(*)	XmlBlasterAccessUnparsedPublishArr (struct XmlBlasterAccessUnparsed *xb, MsgUnitArr *msgUnitArr, XmlBlasterException *exception)
typedef void(*)	XmlBlasterAccessUnparsedPublishOneway (struct XmlBlasterAccessUnparsed *xb, MsgUnitArr *msgUnitArr, XmlBlasterException *exception)
typedef char *(*)	XmlBlasterAccessUnparsedSubscribe (struct XmlBlasterAccessUnparsed *xb, const char *const key, const char *qos, XmlBlasterException *exception)
typedef QosArr *(*)	XmlBlasterAccessUnparsedUnSubscribe (struct XmlBlasterAccessUnparsed *xb, const char *const key, const char *qos, XmlBlasterException *exception)
typedef QosArr *(*)	XmlBlasterAccessUnparsedErase (struct XmlBlasterAccessUnparsed *xb, const char *const key, const char *qos, XmlBlasterException *exception)
typedef MsgUnitArr *(*)	XmlBlasterAccessUnparsedGet (struct XmlBlasterAccessUnparsed *xb, const char *const key, const char *qos, XmlBlasterException *exception)
typedef char *(*)	XmlBlasterAccessUnparsedPing (struct XmlBlasterAccessUnparsed *xb, const char *const qos, XmlBlasterException *exception)
typedef int(*)	XmlBlasterAccessUnparsedIsConnected (struct XmlBlasterAccessUnparsed *xb)
typedef void(*)	XmlBlasterAccessGenericFp ()
Functions
XmlBlasterAccessUnparsed *	getXmlBlasterAccessUnparsed (int argc, const char *const *argv)
	Create an instance to access xmlBlaster.
void	freeXmlBlasterAccessUnparsed (XmlBlasterAccessUnparsed *xmlBlasterAccess)
	Free your instance after accessing xmlBlaster.
const char *	xmlBlasterAccessUnparsedUsage (char *usage)
	Help usage.

---

Typedef Documentation

typedef int(*) UpdateFp(MsgUnitArr *msg, void *userData, XmlBlasterException *xmlBlasterException)

Definition at line 82 of file XmlBlasterAccessUnparsed.h.

typedef void( * ) XmlBlasterAccessGenericFp()

Definition at line 98 of file XmlBlasterAccessUnparsed.h.

typedef char*( * ) XmlBlasterAccessUnparsedConnect(struct XmlBlasterAccessUnparsed *xb, const char *const qos, UpdateFp update, XmlBlasterException *exception)

Definition at line 85 of file XmlBlasterAccessUnparsed.h.

typedef int( * ) XmlBlasterAccessUnparsedDisconnect(struct XmlBlasterAccessUnparsed *xb, const char *qos, XmlBlasterException *exception)

Definition at line 87 of file XmlBlasterAccessUnparsed.h.

typedef QosArr*( * ) XmlBlasterAccessUnparsedErase(struct XmlBlasterAccessUnparsed *xb, const char *const key, const char *qos, XmlBlasterException *exception)

Definition at line 93 of file XmlBlasterAccessUnparsed.h.

typedef MsgUnitArr*( * ) XmlBlasterAccessUnparsedGet(struct XmlBlasterAccessUnparsed *xb, const char *const key, const char *qos, XmlBlasterException *exception)

Definition at line 94 of file XmlBlasterAccessUnparsed.h.

typedef int( * ) XmlBlasterAccessUnparsedInitialize(struct XmlBlasterAccessUnparsed *xa, UpdateFp update, XmlBlasterException *exception)

Definition at line 86 of file XmlBlasterAccessUnparsed.h.

typedef int( * ) XmlBlasterAccessUnparsedIsConnected(struct XmlBlasterAccessUnparsed *xb)

Definition at line 96 of file XmlBlasterAccessUnparsed.h.

typedef char*( * ) XmlBlasterAccessUnparsedPing(struct XmlBlasterAccessUnparsed *xb, const char *const qos, XmlBlasterException *exception)

Definition at line 95 of file XmlBlasterAccessUnparsed.h.

typedef char*( * ) XmlBlasterAccessUnparsedPublish(struct XmlBlasterAccessUnparsed *xb, MsgUnit *msgUnit, XmlBlasterException *exception)

Definition at line 88 of file XmlBlasterAccessUnparsed.h.

typedef QosArr*( * ) XmlBlasterAccessUnparsedPublishArr(struct XmlBlasterAccessUnparsed *xb, MsgUnitArr *msgUnitArr, XmlBlasterException *exception)

Definition at line 89 of file XmlBlasterAccessUnparsed.h.

typedef void( * ) XmlBlasterAccessUnparsedPublishOneway(struct XmlBlasterAccessUnparsed *xb, MsgUnitArr *msgUnitArr, XmlBlasterException *exception)

Definition at line 90 of file XmlBlasterAccessUnparsed.h.

typedef char*( * ) XmlBlasterAccessUnparsedSubscribe(struct XmlBlasterAccessUnparsed *xb, const char *const key, const char *qos, XmlBlasterException *exception)

Definition at line 91 of file XmlBlasterAccessUnparsed.h.

typedef QosArr*( * ) XmlBlasterAccessUnparsedUnSubscribe(struct XmlBlasterAccessUnparsed *xb, const char *const key, const char *qos, XmlBlasterException *exception)

Definition at line 92 of file XmlBlasterAccessUnparsed.h.

---

Function Documentation

void freeXmlBlasterAccessUnparsed

(

XmlBlasterAccessUnparsed *

xmlBlasterAccess

)

Free your instance after accessing xmlBlaster.

Definition at line 136 of file XmlBlasterAccessUnparsed.c.

References XmlBlasterAccessUnparsed::callbackP, XmlBlasterAccessUnparsed::callbackThreadId, XmlBlasterAccessUnparsed::connectionP, freeCallbackServerUnparsed(), freeProperties(), freeXmlBlasterConnectionUnparsed(), get_pthread_id(), PropertiesStruct::getBool, getStackTrace(), XmlBlasterAccessUnparsed::isShutdown, CallbackServerUnparsedStruct::isShutdown, XmlBlasterAccessUnparsed::log, XmlBlasterAccessUnparsed::logLevel, XmlBlasterAccessUnparsed::logUserP, XmlBlasterAccessUnparsed::props, XmlBlasterAccessUnparsed::readnMutex, CallbackServerUnparsedStruct::shutdown, XmlBlasterConnectionUnparsedStruct::shutdown, sleepMillis(), XmlBlasterAccessUnparsed::threadCounter, XmlBlasterAccessUnparsed::writenMutex, XMLBLASTER_LOG_ERROR, XMLBLASTER_LOG_INFO, XMLBLASTER_LOG_TRACE, and XMLBLASTER_LOG_WARN.

Referenced by freeXmlBlasterAccessUnparsedUnmanaged(), freeXmlBlasterAccessUnparsedUnmanagedCE(), getXmlBlasterAccessUnparsed(), main(), and myUpdate().

Here is the call graph for this function:

XmlBlasterAccessUnparsed* getXmlBlasterAccessUnparsed	(	int	argc,
		const char *const *	argv
	)

Create an instance to access xmlBlaster.

This is usually the first call of a client.

Every call creates a new and independent client access instance to xmlBlaster

Our properties point on the passed argv memory, so you should not free the original argv memory before you free XmlBlasterAccessUnparsed.

Parameters:

	argc	The number of argv properties
	argv	The command line properties, see createProperties() for a specification, can be NULL for argc==0

Returns:

NULL if bootstrapping failed. If not NULL you need to free memory when you are done usually by calling freeXmlBlasterAccessUnparsed().

Referenced by getXmlBlasterAccessUnparsedUnmanaged(), getXmlBlasterAccessUnparsedUnmanagedCE(), and main().

const char* xmlBlasterAccessUnparsedUsage

(

char *

usage

)

Help usage.

Parameters:

usage

Please pass a string with at least XMLBLASTER_MAX_USAGE_LEN chars allocated (or on stack)

Returns:

Your usage pointer filled with informations

Definition at line 605 of file XmlBlasterAccessUnparsed.c.

References callbackServerRawUsage(), SNPRINTF, XMLBLASTER_MAX_USAGE_LEN, and xmlBlasterConnectionUnparsedUsage().

Referenced by main(), xmlBlasterUnmanagedCEUsage(), and xmlBlasterUnmanagedUsage().

Here is the call graph for this function: