/usr/include/mama/msgqualifier.h is in libmama-dev 2.2.2.1-11.1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 | /* $Id$
*
* OpenMAMA: The open middleware agnostic messaging API
* Copyright (C) 2011 NYSE Technologies, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301 USA
*/
#ifndef MSG_QUALIFIER_H__
#define MSG_QUALIFIER_H__
#include <mama/config.h>
#include <mama/types.h>
#include <mama/status.h>
#if defined(__cplusplus)
extern "C" {
#endif
#define MAMA_MSG_QUAL_MAX_STR_LEN (100)
#define MAMA_MSG_QUAL_POSSIBLY_DUPLICATE 0x0001
#define MAMA_MSG_QUAL_DEFINITELY_DUPLICATE 0x0002
#define MAMA_MSG_QUAL_POSSIBLY_DELAYED 0x0004
#define MAMA_MSG_QUAL_DEFINITELY_DELAYED 0x0008
#define MAMA_MSG_QUAL_OUT_OF_SEQUENCE 0x0010
#define MAMA_MSG_QUAL_NOT_USED 0x1000
/**
* Create a mamaMsgQual object.
*
* @param msgQual The location of a mamaMsgQual where to store the result.
*/
MAMAExpDLL
extern mama_status
mamaMsgQual_create (
mamaMsgQual* msgQual);
/**
* Destroy a mamaMsgQual object.
*
* @param msgQual The object to destroy.
*/
MAMAExpDLL
extern mama_status
mamaMsgQual_destroy (
mamaMsgQual msgQual);
/**
* Clear a mamaMsgQual object.
*
* @param msgQual The object to clear.
*/
MAMAExpDLL
extern mama_status
mamaMsgQual_clear (
mamaMsgQual msgQual);
/**
* Copy a mamaMsgQual object. The destination object must have already
* been allocated using mamaMsgQual_create().
* @param dest The destination mamaMsgQual.
* @param src The mamaMsgQual to copy.
*/
MAMAExpDLL
extern mama_status
mamaMsgQual_copy (
mamaMsgQual dest,
const mamaMsgQual src);
/**
* Check for equality between two objects.
* @param lhs The first object to compare.
* @param rhs The second object to compare.
*/
MAMAExpDLL
extern int
mamaMsgQual_equal (
const mamaMsgQual lhs,
const mamaMsgQual rhs);
/**
* Set the value.
*
* @param msgQual The object to set.
* @param value The value to set to.
*/
MAMAExpDLL
extern mama_status
mamaMsgQual_setValue (
mamaMsgQual msgQual,
mama_u16_t value);
/**
* Set the bit associated with the Definitely Duplicate condition.
*
* @param msgQual The object to set.
* @param state Zero value clears Definitely Duplicate bit.
* Non-zero value sets Definitely Duplicate bit.
*/
MAMAExpDLL
extern mama_status
mamaMsgQual_setIsDefinitelyDuplicate (
mamaMsgQual msgQual,
int state);
/**
* Set the bit associated with the Possibly Duplicate condition.
*
* @param msgQual The object to set.
* @param state Zero value clears Possibly Duplicate bit.
* Non-zero value sets Possibly Duplicate bit.
*/
MAMAExpDLL
extern mama_status
mamaMsgQual_setIsPossiblyDuplicate (
mamaMsgQual msgQual,
int state);
/**
* Set the bit associated with the Definitely Delayed condition.
*
* @param msgQual The object to set.
* @param state Zero value clears Definitely Delayed bit.
* Non-zero value sets Definitely Delayed bit.
*/
MAMAExpDLL
extern mama_status
mamaMsgQual_setIsDefinitelyDelayed (
mamaMsgQual msgQual,
int state);
/**
* Set the bit associated with the Possibly Delayed condition.
*
* @param msgQual The object to set.
* @param state Zero value clears Possibly Delayed bit.
* Non-zero value sets Possibly Delayed bit.
*/
MAMAExpDLL
extern mama_status
mamaMsgQual_setIsPossiblyDelayed (
mamaMsgQual msgQual,
int state);
/**
* Set the bit associated with the Out Of Sequence condition.
*
* @param msgQual The object to set.
* @param state Zero value clears Out Of Sequence bit.
* Non-zero value sets Out Of Sequence bit.
*/
MAMAExpDLL
extern mama_status
mamaMsgQual_setIsOutOfSequence (
mamaMsgQual msgQual,
int state);
/**
* Determine whether the message qualifier indicates
* that the "msg" is Definitely Duplicate.
*
* @param msgQual The mamaMsgQual object.
* @param result (out) Pointer to the result.
* "1" indicates a positive result.
* "0" indicates a negative result.
*/
MAMAExpDLL
extern mama_status
mamaMsgQual_getIsDefinitelyDuplicate (
mamaMsgQual msgQual,
int* result);
/**
* Determine whether the message qualifier indicates
* that the "msg" is Possibly Duplicate.
*
* @param msgQual The mamaMsgQual object.
* @param result (out) Pointer to the result.
* "1" indicates a positive result.
* "0" indicates a negative result.
*/
MAMAExpDLL
extern mama_status
mamaMsgQual_getIsPossiblyDuplicate (
mamaMsgQual msgQual,
int* result);
/**
* Determine whether the message qualifier indicates
* that the "msg" is Definitely Delayed.
*
* @param msgQual The mamaMsgQual object.
* @param result (out) Pointer to the result.
* "1" indicates a positive result.
* "0" indicates a negative result.
*/
MAMAExpDLL
extern mama_status
mamaMsgQual_getIsDefinitelyDelayed (
mamaMsgQual msgQual,
int* result);
/**
* Determine whether the message qualifier indicates
* that the "msg" is Possibly Delayed.
*
* @param msgQual The mamaMsgQual object.
* @param result (out) Pointer to the result.
* "1" indicates a positive result.
* "0" indicates a negative result.
*/
MAMAExpDLL
extern mama_status
mamaMsgQual_getIsPossiblyDelayed (
mamaMsgQual msgQual,
int* result);
/**
* Determine whether the message qualifier indicates
* that the "msg" is Out Of Sequence Delayed.
*
* @param msgQual The mamaMsgQual object.
* @param result (out) Pointer to the result.
* "1" indicates a positive result.
* "0" indicates a negative result.
*/
MAMAExpDLL
extern mama_status
mamaMsgQual_getIsOutOfSequence (
mamaMsgQual msgQual,
int* result);
/**
* Get the message qualifier value.
*
* @param msgQual The mamaMsgQual object.
* @param value The integer value of the message qualifier.
*/
MAMAExpDLL
extern mama_status
mamaMsgQual_getValue(
const mamaMsgQual msgQual,
mama_u16_t* value);
/**
* Get the message qualifier value as a delimited string.
*
* @param msgQual The mamaMsgQual object.
* @param delimiter The delimiter to separate individual condition strings.
* @param str The string buffer to update.
* @param maxLen The maximum size of the string buffer
* (including trailing '\\0').
*/
MAMAExpDLL
extern 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.
*
* @param value The value of the message qualifier.
* @param delimiter The delimiter to separate individual conditions strings.
* @param str The string buffer to update.
* @param maxLen The maximum size of the string buffer
* (including trailing '\\0').
*/
MAMAExpDLL
extern mama_status
mamaMsgQual_valueToString(
mama_u16_t value,
const char* delimiter,
char* str,
mama_size_t maxLen);
#if defined(__cplusplus)
}
#endif
#endif /* MSG_QUALIFIER_H__ */
|