cMsg Messaging System  6.0
•All Classes Namespaces Files Functions Variables Friends
cMsg.hxx
Go to the documentation of this file.
1 // still to do:
2 
3 // why is myMsgPointer public?
4 // is friend class needed?
5 // should subscription config be public?
6 // add stream operators to cMsgMessage? e.g: msg << setName(aName) << aValue;
7 
8 
9 
10 /*----------------------------------------------------------------------------*
11 * Copyright (c) 2005 Southeastern Universities Research Association, *
12 * Thomas Jefferson National Accelerator Facility *
13 * *
14 * This software was developed under a United States Government license *
15 * described in the NOTICE file included as part of this distribution. *
16 * *
17 * E.Wolin, 25-Feb-2005, Jefferson Lab *
18 * *
19 * Authors: Elliott Wolin *
20 * wolin@jlab.org Jefferson Lab, MS-6B *
21 * Phone: (757) 269-7365 12000 Jefferson Ave. *
22 * Fax: (757) 269-5519 Newport News, VA 23606 *
23 *
24 *----------------------------------------------------------------------------*/
25 
26 
27 #ifndef _cMsg_hxx
28 #define _cMsg_hxx
29 
30 
31 #include <cMsg.h>
32 #include <string>
33 #include <exception>
34 #include <vector>
35 #include <map>
36 
37 
41 namespace cmsg {
42 
43 using namespace std;
44 
45 
46 //-----------------------------------------------------------------------------
47 //-----------------------------------------------------------------------------
48 
49 
53 class cMsgException : public std::exception {
54 
55 public:
56  cMsgException(void);
57  cMsgException(const string &descr);
58  cMsgException(const string &descr, int code);
59  cMsgException(const cMsgException &e);
60  virtual ~cMsgException(void) throw();
61 
62  virtual string toString(void) const throw();
63  virtual const char *what(void) const throw();
64 
65 
66 public:
67  string descr;
68  int returnCode;
69 };
70 
71 
72 //-----------------------------------------------------------------------------
73 //-----------------------------------------------------------------------------
74 
75 
79 class cMsgMessage {
80 
81  friend class cMsg;
84 public:
85  cMsgMessage(void) ;
86  cMsgMessage(const cMsgMessage &m) ;
87  cMsgMessage(void *msgPointer);
88  virtual ~cMsgMessage(void);
89 
90  virtual string getSubject(void) const;
91  virtual void setSubject(const string &subject) ;
92  virtual string getType(void) const;
93  virtual void setType(const string &type) ;
94  virtual string getText(void) const;
95  virtual void setText(const string &text) ;
96 
97  virtual void setByteArrayLength(int length) ;
98  virtual void resetByteArrayLength();
99  virtual int getByteArrayLength(void);
100  virtual int getByteArrayLengthFull(void);
101  virtual void setByteArrayOffset(int offset) ;
102  virtual int getByteArrayOffset(void);
103  virtual int getByteArrayEndian(void);
104  virtual void setByteArrayEndian(int endian) ;
105  virtual bool needToSwap(void) const;
106  virtual char* getByteArray(void);
107  virtual void setByteArray(char *array, int length) ;
108  virtual void setByteArrayNoCopy(char* array, int length);
109 
110  virtual int getUserInt(void) const;
111  virtual void setUserInt(int i) ;
112  virtual struct timespec getUserTime(void) const;
113  virtual void setUserTime(const struct timespec &userTime);
114  virtual int getVersion(void) const;
115  virtual string getDomain(void) const;
116  virtual string getReceiver(void) const;
117  virtual string getReceiverHost(void) const;
118  virtual string getSender(void) const;
119  virtual string getSenderHost(void) const;
120  virtual struct timespec getReceiverTime(void) const;
121  virtual struct timespec getSenderTime(void) const;
122  virtual bool isGetRequest(void) const;
123  virtual bool isGetResponse(void) const;
124  virtual bool isNullGetResponse(void) const;
125 
126  virtual void makeNullResponse(const cMsgMessage &msg) ;
127  virtual void makeNullResponse(const cMsgMessage *msg) ;
128  virtual void makeResponse(const cMsgMessage &msg) ;
129  virtual void makeResponse(const cMsgMessage *msg) ;
130 
131  virtual void setGetResponse(bool b) ;
132  virtual void setNullGetResponse(bool b) ;
133  virtual string toString(void) const;
134  virtual cMsgMessage *copy(void) const;
135  virtual cMsgMessage *nullResponse(void) const;
136  virtual cMsgMessage *response(void) const;
137  virtual string getSubscriptionDomain() const;
138  virtual string getSubscriptionSubject() const;
139  virtual string getSubscriptionType() const;
140  virtual string getSubscriptionUDL() const;
141  virtual int getSubscriptionCueSize(void) const;
142  virtual bool getReliableSend(void) const;
143  virtual void setReliableSend(bool b) ;
144 
145 
146 
147  //---------------
148  // PAYLOAD STUFF
149  //---------------
150 
151 
152 public:
153 
154  virtual bool hasPayload() const;
155 
156  virtual void payloadClear(void);
157  virtual void payloadReset(void);
158  virtual void payloadPrint(void) const;
159  virtual void payloadCopy(const cMsgMessage &msg) ;
160 
161  virtual bool payloadRemoveField(const string &name);
162  virtual string payloadGetText() const;
163  virtual void payloadSetFromText(const string &txt) ;
164  virtual string payloadGetFieldDescription(const string &name) const;
165 
166  virtual map<string,int> *payloadGet() const;
167  virtual int payloadGetCount() const;
168  virtual bool payloadContainsName (const string &name) const;
169  virtual int payloadGetType (const string &name) const;
170  virtual void setHistoryLengthMax (int len) const;
171 
172 
173  //
174  // Methods to get a payload item's value
175  //
176  virtual void getBinary(const string &name, const char **val, int &len, int &endian)
177  const;
178  virtual void getBinaryArray(const string &name, const char ***vals, int **lens, int **endians, int &count)
179  const;
180 
181  virtual cMsgMessage *getMessage(const string &name) const;
182  virtual vector<cMsgMessage> *getMessageVector(const string &name) const;
183  virtual vector<cMsgMessage*> *getMessagePVector(const string &name) const;
184  virtual cMsgMessage *getMessageArray (const string &name) const;
185  virtual cMsgMessage* *getMessagePArray (const string &name) const;
186 
187  virtual string getString(const string &name) const;
188  virtual vector<string> *getStringVector(const string &name) const;
189  virtual string *getStringArray(const string &name) const;
190 
191  virtual float getFloat(const string &name) const;
192  virtual vector<float> *getFloatVector(const string &name) const;
193  virtual float *getFloatArray(const string &name) const;
194 
195  virtual double getDouble(const string &name) const;
196  virtual vector<double> *getDoubleVector(const string &name) const;
197  virtual double *getDoubleArray(const string &name) const;
198 
199  virtual int8_t getInt8 (const string &name) const;
200  virtual int16_t getInt16 (const string &name) const;
201  virtual int32_t getInt32 (const string &name) const;
202  virtual int64_t getInt64 (const string &name) const;
203 
204  virtual vector<int8_t> *getInt8Vector (const string &name) const;
205  virtual vector<int16_t> *getInt16Vector(const string &name) const;
206  virtual vector<int32_t> *getInt32Vector(const string &name) const;
207  virtual vector<int64_t> *getInt64Vector(const string &name) const;
208 
209  virtual int8_t *getInt8Array (const string &name) const;
210  virtual int16_t *getInt16Array (const string &name) const;
211  virtual int32_t *getInt32Array (const string &name) const;
212  virtual int64_t *getInt64Array (const string &name) const;
213 
214 
215  virtual uint8_t getUint8 (const string &name) const;
216  virtual uint16_t getUint16(const string &name) const;
217  virtual uint32_t getUint32(const string &name) const;
218  virtual uint64_t getUint64(const string &name) const;
219 
220  virtual vector<uint8_t> *getUint8Vector (const string &name) const;
221  virtual vector<uint16_t> *getUint16Vector(const string &name) const;
222  virtual vector<uint32_t> *getUint32Vector(const string &name) const;
223  virtual vector<uint64_t> *getUint64Vector(const string &name) const;
224 
225  virtual uint8_t *getUint8Array (const string &name) const;
226  virtual uint16_t *getUint16Array (const string &name) const;
227  virtual uint32_t *getUint32Array (const string &name) const;
228  virtual uint64_t *getUint64Array (const string &name) const;
229 
230 
231  //
232  // Methods to add items to a payload
233  //
234 
235  virtual void add(const string &name, const char *src, int size, int endian);
236  virtual void add(const string &name, const char **srcs, int number,
237  const int sizes[], const int endians[]);
238 
239  virtual void add(const string &name, const string &s);
240  virtual void add(const string &name, const string *s);
241  virtual void add(const string &name, const char **strs, int len);
242  virtual void add(const string &name, const string *strs, int len);
243  virtual void add(const string &name, const vector<string> &strs);
244  virtual void add(const string &name, const vector<string> *strs);
245 
246  virtual void add(const string &name, const cMsgMessage &msg);
247  virtual void add(const string &name, const cMsgMessage *msg);
248  virtual void add(const string &name, const cMsgMessage *msg, int len);
249  virtual void add(const string &name, const cMsgMessage* *msg, int len);
250  virtual void add(const string &name, const vector<cMsgMessage> &msgVec);
251  virtual void add(const string &name, const vector<cMsgMessage> *msgVec);
252  virtual void add(const string &name, const vector<cMsgMessage*> &msgPVec);
253  virtual void add(const string &name, const vector<cMsgMessage*> *msgPVec);
254 
255  virtual void add(const string &name, float val);
256  virtual void add(const string &name, double val);
257  virtual void add(const string &name, const float *vals, int len);
258  virtual void add(const string &name, const double *vals, int len);
259  virtual void add(const string &name, const vector<float> &vals);
260  virtual void add(const string &name, const vector<float> *vals);
261  virtual void add(const string &name, const vector<double> &vals);
262  virtual void add(const string &name, const vector<double> *vals);
263 
264  virtual void add(const string &name, int8_t val);
265  virtual void add(const string &name, int16_t val);
266  virtual void add(const string &name, int32_t val);
267  virtual void add(const string &name, int64_t val);
268 
269  virtual void add(const string &name, uint8_t val);
270  virtual void add(const string &name, uint16_t val);
271  virtual void add(const string &name, uint32_t val);
272  virtual void add(const string &name, uint64_t val);
273 
274  virtual void add(const string &name, const int8_t *vals, int len);
275  virtual void add(const string &name, const int16_t *vals, int len);
276  virtual void add(const string &name, const int32_t *vals, int len);
277  virtual void add(const string &name, const int64_t *vals, int len);
278 
279  virtual void add(const string &name, const uint8_t *vals, int len);
280  virtual void add(const string &name, const uint16_t *vals, int len);
281  virtual void add(const string &name, const uint32_t *vals, int len);
282  virtual void add(const string &name, const uint64_t *vals, int len);
283 
284  virtual void add(const string &name, const vector<int8_t> &vals);
285  virtual void add(const string &name, const vector<int8_t> *vals);
286  virtual void add(const string &name, const vector<int16_t> &vals);
287  virtual void add(const string &name, const vector<int16_t> *vals);
288  virtual void add(const string &name, const vector<int32_t> &vals);
289  virtual void add(const string &name, const vector<int32_t> *vals);
290  virtual void add(const string &name, const vector<int64_t> &vals);
291  virtual void add(const string &name, const vector<int64_t> *vals);
292 
293  virtual void add(const string &name, const vector<uint8_t> &vals);
294  virtual void add(const string &name, const vector<uint8_t> *vals);
295  virtual void add(const string &name, const vector<uint16_t> &vals);
296  virtual void add(const string &name, const vector<uint16_t> *vals);
297  virtual void add(const string &name, const vector<uint32_t> &vals);
298  virtual void add(const string &name, const vector<uint32_t> *vals);
299  virtual void add(const string &name, const vector<uint64_t> &vals);
300  virtual void add(const string &name, const vector<uint64_t> *vals);
301 
302 
303 public:
304  void *myMsgPointer;
305 };
306 
307 
308 //-----------------------------------------------------------------------------
309 //-----------------------------------------------------------------------------
310 
311 
315 class cMsgCallback {
316 
317 public:
318  virtual void callback(cMsgMessage *msg, void *userObject) = 0;
319  virtual ~cMsgCallback() {};
320 };
321 
322 
323 //-----------------------------------------------------------------------------
324 //-----------------------------------------------------------------------------
325 
326 
330 class cMsgSubscriptionConfig {
331 
332 public:
333  cMsgSubscriptionConfig(void);
334  virtual ~cMsgSubscriptionConfig(void);
335 
336  virtual int getMaxCueSize(void) const;
337  virtual void setMaxCueSize(int size);
338  virtual int getSkipSize(void) const;
339  virtual void setSkipSize(int size);
340  virtual bool getMaySkip(void) const;
341  virtual void setMaySkip(bool maySkip);
342  virtual bool getMustSerialize(void) const;
343  virtual void setMustSerialize(bool mustSerialize);
344  virtual int getMaxThreads(void) const;
345  virtual void setMaxThreads(int max);
346  virtual int getMessagesPerThread(void) const;
347  virtual void setMessagesPerThread(int mpt);
348  virtual size_t getStackSize(void) const;
349  virtual void setStackSize(size_t size);
350 
351 public: // cMsg class must pass this to underlying C routines
352  cMsgSubscribeConfig *config;
353 };
354 
355 
356 //-----------------------------------------------------------------------------
357 //-----------------------------------------------------------------------------
358 
359 
363 class cMsg {
364 
365 public:
366  cMsg(const string &UDL, const string &name, const string &descr);
367  virtual ~cMsg(void);
368  virtual void connect() ;
369  virtual void disconnect(void) ;
370  virtual void send(cMsgMessage &msg);
371  virtual void send(cMsgMessage *msg);
372  virtual int syncSend(cMsgMessage &msg, const struct timespec *timeout = NULL);
373  virtual int syncSend(cMsgMessage *msg, const struct timespec *timeout = NULL);
374  virtual void *subscribe(const string &subject, const string &type, cMsgCallback *cb, void *userArg,
375  const cMsgSubscriptionConfig *cfg = NULL);
376  virtual void *subscribe(const string &subject, const string &type, cMsgCallback &cb, void *userArg,
377  const cMsgSubscriptionConfig *cfg = NULL);
378  virtual void unsubscribe(void *handle);
379  virtual void subscriptionPause(void *handle) ;
380  virtual void subscriptionResume(void *handle) ;
381  virtual void subscriptionQueueClear(void *handle) ;
382  virtual int subscriptionQueueCount(void *handle) ;
383  virtual bool subscriptionQueueIsFull(void *handle) ;
384  virtual int subscriptionMessagesTotal(void *handle);
385  virtual cMsgMessage *sendAndGet(cMsgMessage &sendMsg, const struct timespec *timeout = NULL)
386  ;
387  virtual cMsgMessage *sendAndGet(cMsgMessage *sendMsg, const struct timespec *timeout = NULL)
388  ;
389  virtual cMsgMessage *subscribeAndGet(const string &subject, const string &type, const struct timespec *timeout = NULL)
390  ;
391  virtual void flush(const struct timespec *timeout = NULL);
392  virtual void start(void);
393  virtual void stop(void) ;
394  virtual void setUDL(const string &udl);
395  virtual string getUDL(void) const;
396  virtual string getCurrentUDL(void) const;
397  virtual string getName(void) const;
398  virtual string getDescription(void) const;
399  virtual bool isConnected(void) const;
400  virtual bool isReceiving(void) const;
401  virtual void setShutdownHandler(cMsgShutdownHandler *handler, void* userArg);
402  virtual void shutdownClients(const string &client, int flag);
403  virtual void shutdownServers(const string &server, int flag);
404  virtual cMsgMessage *monitor(const string &monString) ;
405  virtual void setMonitoringString(const string &monString) ;
406 
407 
408 private:
409  void *myDomainId;
410  string myUDL;
411  string myName;
412  string myDescr;
413  bool initialized;
414 };
415 
416 
417 //-----------------------------------------------------------------------------
418 //-----------------------------------------------------------------------------
419 // private templates that should not be in doxygen doc
420 #include <cMsgPrivate.hxx>
421 
422 
423 } // namespace cMsg
424 
425 #endif /* _cMsg_hxx */
426 
cmsg::cMsgCallback
Interface defines callback method.
Definition: cMsg.hxx:315
cmsg::cMsgCallback::~cMsgCallback
virtual ~cMsgCallback()
Definition: cMsg.hxx:319
cmsg::cMsgCallback::callback
virtual void callback(cMsgMessage *msg, void *userObject)=0
cmsg::cMsgException
Exception includes description and return code.
Definition: cMsg.hxx:53
cmsg::cMsgException::returnCode
int returnCode
Return code.
Definition: cMsg.hxx:68
cmsg::cMsgException::descr
string descr
Description.
Definition: cMsg.hxx:67
cmsg::cMsg
Wraps most cMsg C calls, provides main functionality.
Definition: cMsg.hxx:363
cmsg::cMsgMessage
Class for wrapping cMsg message.
Definition: cMsg.hxx:79
cmsg::cMsgMessage::myMsgPointer
void * myMsgPointer
Pointer to C message structure.
Definition: cMsg.hxx:304
cmsg::cMsgSubscriptionConfig
Manages subscriptions configurations.
Definition: cMsg.hxx:330
cmsg::cMsgSubscriptionConfig::config
cMsgSubscribeConfig * config
Pointer to subscription config struct.
Definition: cMsg.hxx:352
cmsg
All cMsg symbols reside in the cmsg namespace.
Definition: cMsg.hxx:41