mama/msgqualifier.h

Functions

	Name
MAMAExpDLL mama_status	mamaMsgQual_create(mamaMsgQual * msgQual)
MAMAExpDLL mama_status	mamaMsgQual_destroy(mamaMsgQual msgQual)
MAMAExpDLL mama_status	mamaMsgQual_clear(mamaMsgQual msgQual)
MAMAExpDLL mama_status	mamaMsgQual_copy(mamaMsgQual dest, const mamaMsgQual src)
MAMAExpDLL int	mamaMsgQual_equal(const mamaMsgQual lhs, const mamaMsgQual rhs)
MAMAExpDLL mama_status	mamaMsgQual_setValue(mamaMsgQual msgQual, mama_u16_t value)
MAMAExpDLL mama_status	mamaMsgQual_setIsDefinitelyDuplicate(mamaMsgQual msgQual, int state)
MAMAExpDLL mama_status	mamaMsgQual_setIsPossiblyDuplicate(mamaMsgQual msgQual, int state)
MAMAExpDLL mama_status	mamaMsgQual_setIsDefinitelyDelayed(mamaMsgQual msgQual, int state)
MAMAExpDLL mama_status	mamaMsgQual_setIsPossiblyDelayed(mamaMsgQual msgQual, int state)
MAMAExpDLL mama_status	mamaMsgQual_setIsOutOfSequence(mamaMsgQual msgQual, int state)
MAMAExpDLL mama_status	mamaMsgQual_getIsDefinitelyDuplicate(mamaMsgQual msgQual, int * result)
MAMAExpDLL mama_status	mamaMsgQual_getIsPossiblyDuplicate(mamaMsgQual msgQual, int * result)
MAMAExpDLL mama_status	mamaMsgQual_getIsDefinitelyDelayed(mamaMsgQual msgQual, int * result)
MAMAExpDLL mama_status	mamaMsgQual_getIsPossiblyDelayed(mamaMsgQual msgQual, int * result)
MAMAExpDLL mama_status	mamaMsgQual_getIsOutOfSequence(mamaMsgQual msgQual, int * result)
MAMAExpDLL mama_status	mamaMsgQual_getValue(const mamaMsgQual msgQual, mama_u16_t * value)
MAMAExpDLL mama_status	mamaMsgQual_getAsString(const mamaMsgQual msgQual, const char * delimiter, char * str, mama_size_t maxLen)
MAMAExpDLL mama_status	mamaMsgQual_valueToString(mama_u16_t value, const char * delimiter, char * str, mama_size_t maxLen)

Defines

	Name
	MAMA_MSG_QUAL_MAX_STR_LEN
	MAMA_MSG_QUAL_POSSIBLY_DUPLICATE
	MAMA_MSG_QUAL_DEFINITELY_DUPLICATE
	MAMA_MSG_QUAL_POSSIBLY_DELAYED
	MAMA_MSG_QUAL_DEFINITELY_DELAYED
	MAMA_MSG_QUAL_OUT_OF_SEQUENCE
	MAMA_MSG_QUAL_NOT_USED

Functions Documentation

function mamaMsgQual_create

MAMAExpDLL mama_status mamaMsgQual_create(
    mamaMsgQual * msgQual
)

Parameters:

msgQual The location of a mamaMsgQual where to store the result.

Create a mamaMsgQual object.

function mamaMsgQual_destroy

MAMAExpDLL mama_status mamaMsgQual_destroy(
    mamaMsgQual msgQual
)

Parameters:

msgQual The object to destroy.

Destroy a mamaMsgQual object.

function mamaMsgQual_clear

MAMAExpDLL mama_status mamaMsgQual_clear(
    mamaMsgQual msgQual
)

Parameters:

msgQual The object to clear.

Clear a mamaMsgQual object.

function mamaMsgQual_copy

MAMAExpDLL mama_status mamaMsgQual_copy(
    mamaMsgQual dest,
    const mamaMsgQual src
)

Parameters:

dest The destination mamaMsgQual.
src The mamaMsgQual to copy.

Copy a mamaMsgQual object. The destination object must have already been allocated using mamaMsgQual_create().

function mamaMsgQual_equal

MAMAExpDLL int mamaMsgQual_equal(
    const mamaMsgQual lhs,
    const mamaMsgQual rhs
)

Parameters:

lhs The first object to compare.
rhs The second object to compare.

Check for equality between two objects.

function mamaMsgQual_setValue

MAMAExpDLL mama_status mamaMsgQual_setValue(
    mamaMsgQual msgQual,
    mama_u16_t value
)

Parameters:

msgQual The object to set.
value The value to set to.

Set the value.

function mamaMsgQual_setIsDefinitelyDuplicate

MAMAExpDLL mama_status mamaMsgQual_setIsDefinitelyDuplicate(
    mamaMsgQual msgQual,
    int state
)

Parameters:

msgQual The object to set.
state Zero value clears Definitely Duplicate bit. Non-zero value sets Definitely Duplicate bit.

Set the bit associated with the Definitely Duplicate condition.

function mamaMsgQual_setIsPossiblyDuplicate

MAMAExpDLL mama_status mamaMsgQual_setIsPossiblyDuplicate(
    mamaMsgQual msgQual,
    int state
)

Parameters:

msgQual The object to set.
state Zero value clears Possibly Duplicate bit. Non-zero value sets Possibly Duplicate bit.

Set the bit associated with the Possibly Duplicate condition.

function mamaMsgQual_setIsDefinitelyDelayed

MAMAExpDLL mama_status mamaMsgQual_setIsDefinitelyDelayed(
    mamaMsgQual msgQual,
    int state
)

Parameters:

msgQual The object to set.
state Zero value clears Definitely Delayed bit. Non-zero value sets Definitely Delayed bit.

Set the bit associated with the Definitely Delayed condition.

function mamaMsgQual_setIsPossiblyDelayed

MAMAExpDLL mama_status mamaMsgQual_setIsPossiblyDelayed(
    mamaMsgQual msgQual,
    int state
)

Parameters:

msgQual The object to set.
state Zero value clears Possibly Delayed bit. Non-zero value sets Possibly Delayed bit.

Set the bit associated with the Possibly Delayed condition.

function mamaMsgQual_setIsOutOfSequence

MAMAExpDLL mama_status mamaMsgQual_setIsOutOfSequence(
    mamaMsgQual msgQual,
    int state
)

Parameters:

msgQual The object to set.
state Zero value clears Out Of Sequence bit. Non-zero value sets Out Of Sequence bit.

Set the bit associated with the Out Of Sequence condition.

function mamaMsgQual_getIsDefinitelyDuplicate

MAMAExpDLL mama_status mamaMsgQual_getIsDefinitelyDuplicate(
    mamaMsgQual msgQual,
    int * result
)

Parameters:

msgQual The mamaMsgQual object.
result (out) Pointer to the result. “1” indicates a positive result. “0” indicates a negative result.

Determine whether the message qualifier indicates that the “msg” is Definitely Duplicate.

function mamaMsgQual_getIsPossiblyDuplicate

MAMAExpDLL mama_status mamaMsgQual_getIsPossiblyDuplicate(
    mamaMsgQual msgQual,
    int * result
)

Parameters:

msgQual The mamaMsgQual object.
result (out) Pointer to the result. “1” indicates a positive result. “0” indicates a negative result.

Determine whether the message qualifier indicates that the “msg” is Possibly Duplicate.

function mamaMsgQual_getIsDefinitelyDelayed

MAMAExpDLL mama_status mamaMsgQual_getIsDefinitelyDelayed(
    mamaMsgQual msgQual,
    int * result
)

Parameters:

msgQual The mamaMsgQual object.
result (out) Pointer to the result. “1” indicates a positive result. “0” indicates a negative result.

Determine whether the message qualifier indicates that the “msg” is Definitely Delayed.

function mamaMsgQual_getIsPossiblyDelayed

MAMAExpDLL mama_status mamaMsgQual_getIsPossiblyDelayed(
    mamaMsgQual msgQual,
    int * result
)

Parameters:

msgQual The mamaMsgQual object.
result (out) Pointer to the result. “1” indicates a positive result. “0” indicates a negative result.

Determine whether the message qualifier indicates that the “msg” is Possibly Delayed.

function mamaMsgQual_getIsOutOfSequence

MAMAExpDLL mama_status mamaMsgQual_getIsOutOfSequence(
    mamaMsgQual msgQual,
    int * result
)

Parameters:

msgQual The mamaMsgQual object.
result (out) Pointer to the result.

“1” indicates a positive result. “0” indicates a negative result.

Determine whether the message qualifier indicates that the “msg” is Out Of Sequence Delayed.

function mamaMsgQual_getValue

MAMAExpDLL mama_status mamaMsgQual_getValue(
    const mamaMsgQual msgQual,
    mama_u16_t * value
)

Parameters:

msgQual The mamaMsgQual object.
value The integer value of the message qualifier.

Get the message qualifier value.

function mamaMsgQual_getAsString

MAMAExpDLL mama_status mamaMsgQual_getAsString(
    const mamaMsgQual msgQual,
    const char * delimiter,
    char * str,
    mama_size_t maxLen
)

Parameters:

msgQual The mamaMsgQual object.
delimiter The delimiter to separate individual condition strings.
str The string buffer to update.
maxLen The maximum size of the string buffer (including trailing ‘\0’).

Get the message qualifier value as a delimited string.

function mamaMsgQual_valueToString

MAMAExpDLL mama_status mamaMsgQual_valueToString(
    mama_u16_t value,
    const char * delimiter,
    char * str,
    mama_size_t maxLen
)

Parameters:

value The value of the message qualifier.
delimiter The delimiter to separate individual conditions strings.
str The string buffer to update.
maxLen The maximum size of the string buffer (including trailing ‘\0’).

Get the message qualifier value as a delimited string.

Macros Documentation

define MAMA_MSG_QUAL_MAX_STR_LEN

#define MAMA_MSG_QUAL_MAX_STR_LEN (100)

define MAMA_MSG_QUAL_POSSIBLY_DUPLICATE

#define MAMA_MSG_QUAL_POSSIBLY_DUPLICATE 0x0001

define MAMA_MSG_QUAL_DEFINITELY_DUPLICATE

#define MAMA_MSG_QUAL_DEFINITELY_DUPLICATE 0x0002

define MAMA_MSG_QUAL_POSSIBLY_DELAYED

#define MAMA_MSG_QUAL_POSSIBLY_DELAYED 0x0004

define MAMA_MSG_QUAL_DEFINITELY_DELAYED

#define MAMA_MSG_QUAL_DEFINITELY_DELAYED 0x0008

define MAMA_MSG_QUAL_OUT_OF_SEQUENCE

#define MAMA_MSG_QUAL_OUT_OF_SEQUENCE 0x0010

define MAMA_MSG_QUAL_NOT_USED

#define MAMA_MSG_QUAL_NOT_USED 0x1000

Source code

/* $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

MAMAExpDLL
extern mama_status
mamaMsgQual_create (
    mamaMsgQual*            msgQual);

MAMAExpDLL
extern mama_status
mamaMsgQual_destroy (
    mamaMsgQual             msgQual);

MAMAExpDLL
extern mama_status
mamaMsgQual_clear (
    mamaMsgQual             msgQual);

MAMAExpDLL
extern mama_status
mamaMsgQual_copy (
    mamaMsgQual             dest,
    const mamaMsgQual       src);

MAMAExpDLL
extern int
mamaMsgQual_equal (
    const mamaMsgQual       lhs,
    const mamaMsgQual       rhs);

MAMAExpDLL
extern mama_status
mamaMsgQual_setValue (
    mamaMsgQual             msgQual, 
    mama_u16_t              value);

MAMAExpDLL
extern mama_status
mamaMsgQual_setIsDefinitelyDuplicate (
    mamaMsgQual             msgQual, 
    int                     state);

MAMAExpDLL
extern mama_status
mamaMsgQual_setIsPossiblyDuplicate (
    mamaMsgQual             msgQual,                                 
    int                     state);

MAMAExpDLL
extern mama_status
mamaMsgQual_setIsDefinitelyDelayed (
    mamaMsgQual             msgQual, 
    int                     state);

MAMAExpDLL
extern mama_status
mamaMsgQual_setIsPossiblyDelayed (
    mamaMsgQual             msgQual, 
    int                     state);

MAMAExpDLL
extern mama_status
mamaMsgQual_setIsOutOfSequence (
    mamaMsgQual             msgQual, 
    int                     state);

MAMAExpDLL
extern mama_status
mamaMsgQual_getIsDefinitelyDuplicate (
    mamaMsgQual             msgQual, 
    int*                    result);

MAMAExpDLL
extern mama_status
mamaMsgQual_getIsPossiblyDuplicate (
    mamaMsgQual             msgQual, 
    int*                    result);

MAMAExpDLL
extern mama_status
mamaMsgQual_getIsDefinitelyDelayed (
    mamaMsgQual             msgQual, 
    int*                    result);

MAMAExpDLL
extern mama_status
mamaMsgQual_getIsPossiblyDelayed (
    mamaMsgQual             msgQual, 
    int*                    result);

MAMAExpDLL
extern mama_status
mamaMsgQual_getIsOutOfSequence (
    mamaMsgQual             msgQual, 
    int*                    result);


MAMAExpDLL
extern mama_status
mamaMsgQual_getValue(
    const mamaMsgQual       msgQual,
    mama_u16_t*             value);

MAMAExpDLL
extern mama_status
mamaMsgQual_getAsString(
    const mamaMsgQual      msgQual,
    const char*            delimiter,
    char*                  str,
    mama_size_t            maxLen);

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__ */

Updated on 2023-03-31 at 15:29:16 +0100