/usr/include/mama/MamaMsgField.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 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 | /* $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 MAMA_MSG_FIELD_CPP_H__
#define MAMA_MSG_FIELD_CPP_H__
#include <mama/mamacpp.h>
#include <vector>
#include <functional>
using namespace std;
namespace Wombat
{
class MamaMsgFieldImpl;
class MamaFieldDescriptor;
class MamaDateTime;
class MamaPrice;
class MamaMsg;
/**
* MamaMsg field representation.
*/
class MAMACPPExpDLL MamaMsgField
{
public:
~MamaMsgField ();
MamaMsgField (void);
MamaMsgField (
mamaMsgField field);
/**
* Clear the field.
*/
void clear ();
/**
* Set this field to a different MAMA C API field.
*/
void set (
mamaMsgField field);
const MamaFieldDescriptor* getDescriptor () const;
/**
* Return the field identifier.
*
* @return The fid.
*/
mama_fid_t getFid () const;
/**
* Return the field name.
*
* @return The name.
*/
const char* getName () const;
/**
* Return the field type.
*
* @return The type.
*/
mamaFieldType getType () const;
/**
* Return the field type name. The type name is a human readable
* representation of the type.
*
* @return The type name.
*/
const char* getTypeName () const;
/**
* Get as a boolean field.
* @return The boolean value.
*/
mama_bool_t getBool () const;
/**
* Get as a character field.
* @return The character value.
*/
char getChar () const;
/**
* Get as a I8 field.
* @return The integer value.
*/
mama_i8_t getI8 () const;
/**
* Get as a U8 field.
* @return The integer value.
*/
mama_u8_t getU8 () const;
/**
* Get as a I16 field.
* @return The integer value.
*/
mama_i16_t getI16 () const;
/**
* Get as a U16 field.
* @return The integer value.
*/
mama_u16_t getU16 () const;
/**
* Get as a I32 field.
* @return The integer value.
*/
mama_i32_t getI32 () const;
/**
* Get as a U32 field.
* @return The integer value.
*/
mama_u32_t getU32 () const;
/**
* Get as a I64 field.
* @return The field value as a long.
*/
mama_i64_t getI64 () const;
/**
* Get as a U64 field.
* @return The field value as a long.
*/
mama_u64_t getU64 () const;
/**
* Get as a f32 field.
* @return The field value as a 32 bit floating point number.
*/
mama_f32_t getF32 () const;
/**
* Get as a f64 field.
* @return The field value as a 64 bit floating point number.
*/
mama_f64_t getF64 () const;
/**
* Get as a const char* field.
* @return the string value.
*/
const char* getString () const;
/**
* Get as a const void* field
* @return The opaque value.
*/
const void* getOpaque (
mama_size_t& size) const;
/**
* Get as a MamaDateTime field
* @param result The date/time value.
*/
void getDateTime (
MamaDateTime& result) const;
/**
* Get as a MamaPrice field
* @param result The price value.
*/
void getPrice (
MamaPrice& result) const;
/**
* Get as a MamaMsg field
* @param result The msg value.
*/
void getMsg (
MamaMsg& result) const;
/**
* Get a vector of characters.
* @param result (out) the vector.
* @param resultLen (out) the size of the vector.
*/
void getVectorChar (
const char*& result,
mama_size_t& resultLen) const;
/**
* Get a vector of signed 8-bit integers.
* @param result (out) the vector.
* @param resultLen (out) the size of the vector.
*/
void getVectorI8 (
const mama_i8_t*& result,
mama_size_t& resultLen) const;
/**
* Get a vector of unsigned 8-bit integers.
* @param result (out) the vector.
* @param resultLen (out) the size of the vector.
*/
void getVectorU8 (
const mama_u8_t*& result,
mama_size_t& resultLen) const;
/**
* Get a vector of signed 16-bit integers.
* @param result (out) the vector.
* @param resultLen (out) the size of the vector.
*/
void getVectorI16 (
const mama_i16_t*& result,
mama_size_t& resultLen) const;
/**
* Get a vector of unsigned 16-bit integers.
* @param result (out) the vector.
* @param resultLen (out) the size of the vector.
*/
void getVectorU16 (
const mama_u16_t*& result,
mama_size_t& resultLen) const;
/**
* Get a vector of signed 32-bit integers.
* @param result (out) the vector.
* @param resultLen (out) the size of the vector.
*/
void getVectorI32 (
const mama_i32_t*& result,
mama_size_t& resultLen) const;
/**
* Get a vector of unsigned 32-bit integers.
* @param result (out) the vector.
* @param resultLen (out) the size of the vector.
*/
void getVectorU32 (
const mama_u32_t*& result,
mama_size_t& resultLen) const;
/**
* Get a vector of signed 64-bit integers.
* @param result (out) the vector.
* @param resultLen (out) the size of the vector.
*/
void getVectorI64 (
const mama_i64_t*& result,
mama_size_t& resultLen) const;
/**
* Get a vector of unsigned 64-bit integers.
* @param result (out) the vector.
* @param resultLen (out) the size of the vector.
*/
void getVectorU64 (
const mama_u64_t*& result,
mama_size_t& resultLen) const;
/**
* Get a vector of 32-bit floats.
* @param result (out) the vector.
* @param resultLen (out) the size of the vector.
*/
void getVectorF32 (
const mama_f32_t*& result,
mama_size_t& resultLen) const;
/**
* Get a vector of 64-bit floats.
* @param result (out) the vector.
* @param resultLen (out) the size of the vector.
*/
void getVectorF64 (
const mama_f64_t*& result,
mama_size_t& resultLen) const;
/**
* Get a vector of strings.
* @param result (out) the vector.
* @param resultLen (out) the size of the vector.
*/
void getVectorString (
const char**& result,
mama_size_t& resultLen) const;
/**
* Get a vector of submessages field. Note: The vector is only
* valid for the lifetime of the field object which, when
* iterating over fields in a message is only as long as the
* individual callback itself. Use getVectorMsgDetached if it is
* necessary to keep the vector of messages longer than the
* lifetime of the field.
* @param result (out) vector.
* @param resultLen (out) the size of the vector.
*/
void getVectorMsg (
const MamaMsg**& result,
mama_size_t& resultLen) const;
/**
* Get a vector of submessages field. Deallocating the memory
* allocated for array and it members will become the
* responsibility of the caller.
* @param result (out) vector.
* @param resultLen (out) the size of the vector.
*/
void getVectorMsgDetached (
const MamaMsg**& result,
mama_size_t& resultLen) const;
/**
* Return a string representation the field with the given fid.
* @param result Buffer to put result.
* @param maxResultLen Maximum size of buffer to put result.
*/
void getAsString (
char* result,
mama_size_t maxResultLen) const;
/**
* Update the specified field with a new bool value.
*
* @param value The new value for the field.
*
* @throws MamaStatus exception with the following possible status values.
* MAMA_STATUS_WRONG_FIELD_TYPE The existing field type does not match
* the type of the update method called.
* MAMA_STATUS_NULL_ARG The field passed to the C function is NULL.
* MAMA_STATUS_INVALID_ARG The underlying bridge field is NULL.
*/
void updateBool (
mama_bool_t value);
/**
* Update the specified field with a new char value.
*
* @param value The new value for the field.
*
* @throws MamaStatus exception with the following possible status values.
* MAMA_STATUS_WRONG_FIELD_TYPE The existing field type does not match
* the type of the update method called.
* MAMA_STATUS_NULL_ARG The field passed to the C function is NULL.
* MAMA_STATUS_INVALID_ARG The underlying bridge field is NULL.
*/
void updateChar (
char value);
/**
* Update the specified field with a new i8 value.
*
* @param value The new value for the field.
*
* @throws MamaStatus exception with the following possible status values.
* MAMA_STATUS_WRONG_FIELD_TYPE The existing field type does not match
* the type of the update method called.
* MAMA_STATUS_NULL_ARG The field passed to the C function is NULL.
* MAMA_STATUS_INVALID_ARG The underlying bridge field is NULL.
*/
void updateI8 (
mama_i8_t value);
/**
* Update the specified field with a new u8 value.
*
* @param value The new value for the field.
*
* @throws MamaStatus exception with the following possible status values.
* MAMA_STATUS_WRONG_FIELD_TYPE The existing field type does not match
* the type of the update method called.
* MAMA_STATUS_NULL_ARG The field passed to the C function is NULL.
* MAMA_STATUS_INVALID_ARG The underlying bridge field is NULL.
*/
void updateU8 (
mama_u8_t value);
/**
* Update the specified field with a new i16 value.
*
* @param value The new value for the field.
*
* @throws MamaStatus exception with the following possible status values.
* MAMA_STATUS_WRONG_FIELD_TYPE The existing field type does not match
* the type of the update method called.
* MAMA_STATUS_NULL_ARG The field passed to the C function is NULL.
* MAMA_STATUS_INVALID_ARG The underlying bridge field is NULL.
*/
void updateI16 (
mama_i16_t value);
/**
* Update the specified field with a new u16 value.
*
* @param value The new value for the field.
*
* @throws MamaStatus exception with the following possible status values.
* MAMA_STATUS_WRONG_FIELD_TYPE The existing field type does not match
* the type of the update method called.
* MAMA_STATUS_NULL_ARG The field passed to the C function is NULL.
* MAMA_STATUS_INVALID_ARG The underlying bridge field is NULL.
*/
void updateU16 (
mama_u16_t value);
/**
* Update the specified field with a new i32 value.
*
* @param value The new value for the field.
*
* @throws MamaStatus exception with the following possible status values.
* MAMA_STATUS_WRONG_FIELD_TYPE The existing field type does not match
* the type of the update method called.
* MAMA_STATUS_NULL_ARG The field passed to the C function is NULL.
* MAMA_STATUS_INVALID_ARG The underlying bridge field is NULL.
*/
void updateI32 (
mama_i32_t value);
/**
* Update the specified field with a new u32 value.
*
* @param value The new value for the field.
*
* @throws MamaStatus exception with the following possible status values.
* MAMA_STATUS_WRONG_FIELD_TYPE The existing field type does not match
* the type of the update method called.
* MAMA_STATUS_NULL_ARG The field passed to the C function is NULL.
* MAMA_STATUS_INVALID_ARG The underlying bridge field is NULL.
*/
void updateU32 (
mama_u32_t value);
/**
* Update the specified field with a new i64 value.
*
* @param value The new value for the field.
*
* @throws MamaStatus exception with the following possible status values.
* MAMA_STATUS_WRONG_FIELD_TYPE The existing field type does not match
* the type of the update method called.
* MAMA_STATUS_NULL_ARG The field passed to the C function is NULL.
* MAMA_STATUS_INVALID_ARG The underlying bridge field is NULL.
*/
void updateI64 (
mama_i64_t value);
/**
* Update the specified field with a new u64 value.
*
* @param value The new value for the field.
*
* @throws MamaStatus exception with the following possible status values.
* MAMA_STATUS_WRONG_FIELD_TYPE The existing field type does not match
* the type of the update method called.
* MAMA_STATUS_NULL_ARG The field passed to the C function is NULL.
* MAMA_STATUS_INVALID_ARG The underlying bridge field is NULL.
*/
void updateU64 (
mama_u64_t value);
/**
* Update the specified field with a new f32 value.
*
* @param value The new value for the field.
*
* @throws MamaStatus exception with the following possible status values.
* MAMA_STATUS_WRONG_FIELD_TYPE The existing field type does not match
* the type of the update method called.
* MAMA_STATUS_NULL_ARG The field passed to the C function is NULL.
* MAMA_STATUS_INVALID_ARG The underlying bridge field is NULL.
*/
void updateF32 (
mama_f32_t value);
/**
* Update the specified field with a new f64 value.
*
* @param value The new value for the field.
*
* @throws MamaStatus exception with the following possible status values.
* MAMA_STATUS_WRONG_FIELD_TYPE The existing field type does not match
* the type of the update method called.
* MAMA_STATUS_NULL_ARG The field passed to the C function is NULL.
* MAMA_STATUS_INVALID_ARG The underlying bridge field is NULL.
*/
void updateF64 (
mama_f64_t value);
/**
* Update the specified field with a new date/time value.
*
* @param value The new value for the field (mamaDateTime object).
*
* @throws MamaStatus exception with the following possible status values.
* MAMA_STATUS_WRONG_FIELD_TYPE The existing field type does not match
* the type of the update method called.
* MAMA_STATUS_NULL_ARG The field passed to the C function is NULL.
* MAMA_STATUS_INVALID_ARG The underlying bridge field is NULL.
*/
void updateDateTime (
const mamaDateTime value);
/**
* Update the specified field with a new date/time value.
*
* @param value The new value for the field (MamaDateTime object).
*
* @throws MamaStatus exception with the following possible status values.
* MAMA_STATUS_WRONG_FIELD_TYPE The existing field type does not match
* the type of the update method called.
* MAMA_STATUS_NULL_ARG The field passed to the C function is NULL.
* MAMA_STATUS_INVALID_ARG The underlying bridge field is NULL.
*/
void updateDateTime (
const MamaDateTime value);
/**
* Update the specified field with a new price value.
*
* @param value The new value for the field (mamaPrice object).
*
* @throws MamaStatus exception with the following possible status values.
* MAMA_STATUS_WRONG_FIELD_TYPE The existing field type does not match
* the type of the update method called.
* MAMA_STATUS_NULL_ARG The field passed to the C function is NULL.
* MAMA_STATUS_INVALID_ARG The underlying bridge field is NULL.
*/
void updatePrice (
const mamaPrice value);
/**
* Update the specified field with a new price value.
*
* @param value The new value for the field (MamaPrice object).
*
* @throws MamaStatus exception with the following possible status values.
* MAMA_STATUS_WRONG_FIELD_TYPE The existing field type does not match
* the type of the update method called.
* MAMA_STATUS_NULL_ARG The field passed to the C function is NULL.
* MAMA_STATUS_INVALID_ARG The underlying bridge field is NULL.
*/
void updatePrice (
const MamaPrice value);
bool operator==(const MamaMsgField&) const;
bool operator!=(const MamaMsgField&) const;
private:
mamaMsgField mField;
mutable MamaFieldDescriptor* mFieldDesc;
mutable const MamaMsg** mLastVectorMsg;
mutable mama_size_t mLastVectorMsgLen;
void destroyLastVectorMsg () const;
};
} // namespace Wombat
#endif // MAMA_MSG_FIELD_CPP_H__
|