OpenMAMA
msgqualifier.h
Go to the documentation of this file.
1 /* $Id$
2  *
3  * OpenMAMA: The open middleware agnostic messaging API
4  * Copyright (C) 2011 NYSE Technologies, Inc.
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
19  * 02110-1301 USA
20  */
21 
22 #ifndef MSG_QUALIFIER_H__
23 #define MSG_QUALIFIER_H__
24 
25 #include <mama/config.h>
26 #include <mama/types.h>
27 #include <mama/status.h>
28 
29 #if defined(__cplusplus)
30 extern "C" {
31 #endif
32 
33 #define MAMA_MSG_QUAL_MAX_STR_LEN (100)
34 
35 #define MAMA_MSG_QUAL_POSSIBLY_DUPLICATE 0x0001
36 #define MAMA_MSG_QUAL_DEFINITELY_DUPLICATE 0x0002
37 #define MAMA_MSG_QUAL_POSSIBLY_DELAYED 0x0004
38 #define MAMA_MSG_QUAL_DEFINITELY_DELAYED 0x0008
39 #define MAMA_MSG_QUAL_OUT_OF_SEQUENCE 0x0010
40 #define MAMA_MSG_QUAL_NOT_USED 0x1000
41 
47 MAMAExpDLL
48 extern mama_status
50  mamaMsgQual* msgQual);
51 
57 MAMAExpDLL
58 extern mama_status
60  mamaMsgQual msgQual);
61 
67 MAMAExpDLL
68 extern mama_status
70  mamaMsgQual msgQual);
71 
78 MAMAExpDLL
79 extern mama_status
81  mamaMsgQual dest,
82  const mamaMsgQual src);
83 
89 MAMAExpDLL
90 extern int
92  const mamaMsgQual lhs,
93  const mamaMsgQual rhs);
94 
101 MAMAExpDLL
102 extern mama_status
104  mamaMsgQual msgQual,
105  mama_u16_t value);
106 
114 MAMAExpDLL
115 extern mama_status
117  mamaMsgQual msgQual,
118  int state);
119 
127 MAMAExpDLL
128 extern mama_status
130  mamaMsgQual msgQual,
131  int state);
132 
140 MAMAExpDLL
141 extern mama_status
143  mamaMsgQual msgQual,
144  int state);
145 
153 MAMAExpDLL
154 extern mama_status
156  mamaMsgQual msgQual,
157  int state);
158 
166 MAMAExpDLL
167 extern mama_status
169  mamaMsgQual msgQual,
170  int state);
171 
181 MAMAExpDLL
182 extern mama_status
184  mamaMsgQual msgQual,
185  int* result);
186 
196 MAMAExpDLL
197 extern mama_status
199  mamaMsgQual msgQual,
200  int* result);
201 
211 MAMAExpDLL
212 extern mama_status
214  mamaMsgQual msgQual,
215  int* result);
216 
226 MAMAExpDLL
227 extern mama_status
229  mamaMsgQual msgQual,
230  int* result);
231 
241 MAMAExpDLL
242 extern mama_status
244  mamaMsgQual msgQual,
245  int* result);
246 
247 
254 MAMAExpDLL
255 extern mama_status
257  const mamaMsgQual msgQual,
258  mama_u16_t* value);
259 
269 MAMAExpDLL
270 extern mama_status
272  const mamaMsgQual msgQual,
273  const char* delimiter,
274  char* str,
275  mama_size_t maxLen);
276 
286 MAMAExpDLL
287 extern mama_status
289  mama_u16_t value,
290  const char* delimiter,
291  char* str,
292  mama_size_t maxLen);
293 
294 
295 #if defined(__cplusplus)
296 }
297 #endif
298 
299 #endif /* MSG_QUALIFIER_H__ */
MAMAExpDLL mama_status mamaMsgQual_create(mamaMsgQual *msgQual)
Create a mamaMsgQual object.
MAMAExpDLL int mamaMsgQual_equal(const mamaMsgQual lhs, const mamaMsgQual rhs)
Check for equality between two objects.
MAMAExpDLL mama_status mamaMsgQual_getIsDefinitelyDuplicate(mamaMsgQual msgQual, int *result)
Determine whether the message qualifier indicates that the "msg" is Definitely Duplicate.
struct mamaMsgQualImpl_ * mamaMsgQual
Definition: types.h:114
MAMAExpDLL mama_status mamaMsgQual_setIsDefinitelyDelayed(mamaMsgQual msgQual, int state)
Set the bit associated with the Definitely Delayed condition.
MAMAExpDLL mama_status mamaMsgQual_getIsPossiblyDelayed(mamaMsgQual msgQual, int *result)
Determine whether the message qualifier indicates that the "msg" is Possibly Delayed.
MAMAExpDLL mama_status mamaMsgQual_copy(mamaMsgQual dest, const mamaMsgQual src)
Copy a mamaMsgQual object.
MAMAExpDLL mama_status mamaMsgQual_valueToString(mama_u16_t value, const char *delimiter, char *str, mama_size_t maxLen)
Get the message qualifier value as a delimited string.
MAMAExpDLL mama_status mamaMsgQual_setIsPossiblyDelayed(mamaMsgQual msgQual, int state)
Set the bit associated with the Possibly Delayed condition.
uint16_t mama_u16_t
Definition: types.h:37
MAMAExpDLL mama_status mamaMsgQual_getIsOutOfSequence(mamaMsgQual msgQual, int *result)
Determine whether the message qualifier indicates that the "msg" is Out Of Sequence Delayed...
MAMAExpDLL mama_status mamaMsgQual_getIsDefinitelyDelayed(mamaMsgQual msgQual, int *result)
Determine whether the message qualifier indicates that the "msg" is Definitely Delayed.
MAMAExpDLL mama_status mamaMsgQual_setValue(mamaMsgQual msgQual, mama_u16_t value)
Set the value.
MAMAExpDLL mama_status mamaMsgQual_getValue(const mamaMsgQual msgQual, mama_u16_t *value)
Get the message qualifier value.
MAMAExpDLL mama_status mamaMsgQual_getAsString(const mamaMsgQual msgQual, const char *delimiter, char *str, mama_size_t maxLen)
Get the message qualifier value as a delimited string.
mama_status
Definition: status.h:37
size_t mama_size_t
Definition: types.h:47
MAMAExpDLL mama_status mamaMsgQual_clear(mamaMsgQual msgQual)
Clear a mamaMsgQual object.
MAMAExpDLL mama_status mamaMsgQual_setIsPossiblyDuplicate(mamaMsgQual msgQual, int state)
Set the bit associated with the Possibly Duplicate condition.
MAMAExpDLL mama_status mamaMsgQual_setIsOutOfSequence(mamaMsgQual msgQual, int state)
Set the bit associated with the Out Of Sequence condition.
MAMAExpDLL mama_status mamaMsgQual_destroy(mamaMsgQual msgQual)
Destroy a mamaMsgQual object.
MAMAExpDLL mama_status mamaMsgQual_setIsDefinitelyDuplicate(mamaMsgQual msgQual, int state)
Set the bit associated with the Definitely Duplicate condition.
MAMAExpDLL mama_status mamaMsgQual_getIsPossiblyDuplicate(mamaMsgQual msgQual, int *result)
Determine whether the message qualifier indicates that the "msg" is Possibly Duplicate.


© 2012 Linux Foundation