OpenMAMA
Macros | Functions
msgqualifier.h File Reference
#include <mama/config.h>
#include <mama/types.h>
#include <mama/status.h>

Go to the source code of this file.

Macros

#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
 

Functions

MAMAExpDLL mama_status mamaMsgQual_create (mamaMsgQual *msgQual)
 Create a mamaMsgQual object. More...
 
MAMAExpDLL mama_status mamaMsgQual_destroy (mamaMsgQual msgQual)
 Destroy a mamaMsgQual object. More...
 
MAMAExpDLL mama_status mamaMsgQual_clear (mamaMsgQual msgQual)
 Clear a mamaMsgQual object. More...
 
MAMAExpDLL mama_status mamaMsgQual_copy (mamaMsgQual dest, const mamaMsgQual src)
 Copy a mamaMsgQual object. More...
 
MAMAExpDLL int mamaMsgQual_equal (const mamaMsgQual lhs, const mamaMsgQual rhs)
 Check for equality between two objects. More...
 
MAMAExpDLL mama_status mamaMsgQual_setValue (mamaMsgQual msgQual, mama_u16_t value)
 Set the value. More...
 
MAMAExpDLL mama_status mamaMsgQual_setIsDefinitelyDuplicate (mamaMsgQual msgQual, int state)
 Set the bit associated with the Definitely Duplicate condition. More...
 
MAMAExpDLL mama_status mamaMsgQual_setIsPossiblyDuplicate (mamaMsgQual msgQual, int state)
 Set the bit associated with the Possibly Duplicate condition. More...
 
MAMAExpDLL mama_status mamaMsgQual_setIsDefinitelyDelayed (mamaMsgQual msgQual, int state)
 Set the bit associated with the Definitely Delayed condition. More...
 
MAMAExpDLL mama_status mamaMsgQual_setIsPossiblyDelayed (mamaMsgQual msgQual, int state)
 Set the bit associated with the Possibly Delayed condition. More...
 
MAMAExpDLL mama_status mamaMsgQual_setIsOutOfSequence (mamaMsgQual msgQual, int state)
 Set the bit associated with the Out Of Sequence condition. More...
 
MAMAExpDLL mama_status mamaMsgQual_getIsDefinitelyDuplicate (mamaMsgQual msgQual, int *result)
 Determine whether the message qualifier indicates that the "msg" is Definitely Duplicate. More...
 
MAMAExpDLL mama_status mamaMsgQual_getIsPossiblyDuplicate (mamaMsgQual msgQual, int *result)
 Determine whether the message qualifier indicates that the "msg" is Possibly Duplicate. More...
 
MAMAExpDLL mama_status mamaMsgQual_getIsDefinitelyDelayed (mamaMsgQual msgQual, int *result)
 Determine whether the message qualifier indicates that the "msg" is Definitely Delayed. More...
 
MAMAExpDLL mama_status mamaMsgQual_getIsPossiblyDelayed (mamaMsgQual msgQual, int *result)
 Determine whether the message qualifier indicates that the "msg" is Possibly Delayed. More...
 
MAMAExpDLL mama_status mamaMsgQual_getIsOutOfSequence (mamaMsgQual msgQual, int *result)
 Determine whether the message qualifier indicates that the "msg" is Out Of Sequence Delayed. More...
 
MAMAExpDLL mama_status mamaMsgQual_getValue (const mamaMsgQual msgQual, mama_u16_t *value)
 Get the message qualifier value. More...
 
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. More...
 
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. More...
 

Macro Definition Documentation

◆ MAMA_MSG_QUAL_MAX_STR_LEN

#define MAMA_MSG_QUAL_MAX_STR_LEN   (100)

◆ MAMA_MSG_QUAL_POSSIBLY_DUPLICATE

#define MAMA_MSG_QUAL_POSSIBLY_DUPLICATE   0x0001

◆ MAMA_MSG_QUAL_DEFINITELY_DUPLICATE

#define MAMA_MSG_QUAL_DEFINITELY_DUPLICATE   0x0002

◆ MAMA_MSG_QUAL_POSSIBLY_DELAYED

#define MAMA_MSG_QUAL_POSSIBLY_DELAYED   0x0004

◆ MAMA_MSG_QUAL_DEFINITELY_DELAYED

#define MAMA_MSG_QUAL_DEFINITELY_DELAYED   0x0008

◆ MAMA_MSG_QUAL_OUT_OF_SEQUENCE

#define MAMA_MSG_QUAL_OUT_OF_SEQUENCE   0x0010

◆ MAMA_MSG_QUAL_NOT_USED

#define MAMA_MSG_QUAL_NOT_USED   0x1000

Function Documentation

◆ mamaMsgQual_create()

MAMAExpDLL mama_status mamaMsgQual_create ( mamaMsgQual *  msgQual)

Create a mamaMsgQual object.

Parameters
msgQualThe location of a mamaMsgQual where to store the result.

◆ mamaMsgQual_destroy()

MAMAExpDLL mama_status mamaMsgQual_destroy ( mamaMsgQual  msgQual)

Destroy a mamaMsgQual object.

Parameters
msgQualThe object to destroy.

◆ mamaMsgQual_clear()

MAMAExpDLL mama_status mamaMsgQual_clear ( mamaMsgQual  msgQual)

Clear a mamaMsgQual object.

Parameters
msgQualThe object to clear.

◆ mamaMsgQual_copy()

MAMAExpDLL mama_status mamaMsgQual_copy ( mamaMsgQual  dest,
const mamaMsgQual  src 
)

Copy a mamaMsgQual object.

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

Parameters
destThe destination mamaMsgQual.
srcThe mamaMsgQual to copy.

◆ mamaMsgQual_equal()

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

Check for equality between two objects.

Parameters
lhsThe first object to compare.
rhsThe second object to compare.

◆ mamaMsgQual_setValue()

MAMAExpDLL mama_status mamaMsgQual_setValue ( mamaMsgQual  msgQual,
mama_u16_t  value 
)

Set the value.

Parameters
msgQualThe object to set.
valueThe value to set to.

◆ mamaMsgQual_setIsDefinitelyDuplicate()

MAMAExpDLL mama_status mamaMsgQual_setIsDefinitelyDuplicate ( mamaMsgQual  msgQual,
int  state 
)

Set the bit associated with the Definitely Duplicate condition.

Parameters
msgQualThe object to set.
stateZero value clears Definitely Duplicate bit. Non-zero value sets Definitely Duplicate bit.

◆ mamaMsgQual_setIsPossiblyDuplicate()

MAMAExpDLL mama_status mamaMsgQual_setIsPossiblyDuplicate ( mamaMsgQual  msgQual,
int  state 
)

Set the bit associated with the Possibly Duplicate condition.

Parameters
msgQualThe object to set.
stateZero value clears Possibly Duplicate bit. Non-zero value sets Possibly Duplicate bit.

◆ mamaMsgQual_setIsDefinitelyDelayed()

MAMAExpDLL mama_status mamaMsgQual_setIsDefinitelyDelayed ( mamaMsgQual  msgQual,
int  state 
)

Set the bit associated with the Definitely Delayed condition.

Parameters
msgQualThe object to set.
stateZero value clears Definitely Delayed bit. Non-zero value sets Definitely Delayed bit.

◆ mamaMsgQual_setIsPossiblyDelayed()

MAMAExpDLL mama_status mamaMsgQual_setIsPossiblyDelayed ( mamaMsgQual  msgQual,
int  state 
)

Set the bit associated with the Possibly Delayed condition.

Parameters
msgQualThe object to set.
stateZero value clears Possibly Delayed bit. Non-zero value sets Possibly Delayed bit.

◆ mamaMsgQual_setIsOutOfSequence()

MAMAExpDLL mama_status mamaMsgQual_setIsOutOfSequence ( mamaMsgQual  msgQual,
int  state 
)

Set the bit associated with the Out Of Sequence condition.

Parameters
msgQualThe object to set.
stateZero value clears Out Of Sequence bit. Non-zero value sets Out Of Sequence bit.

◆ mamaMsgQual_getIsDefinitelyDuplicate()

MAMAExpDLL mama_status mamaMsgQual_getIsDefinitelyDuplicate ( mamaMsgQual  msgQual,
int *  result 
)

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

Parameters
msgQualThe mamaMsgQual object.
result(out) Pointer to the result. "1" indicates a positive result. "0" indicates a negative result.

◆ mamaMsgQual_getIsPossiblyDuplicate()

MAMAExpDLL mama_status mamaMsgQual_getIsPossiblyDuplicate ( mamaMsgQual  msgQual,
int *  result 
)

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

Parameters
msgQualThe mamaMsgQual object.
result(out) Pointer to the result. "1" indicates a positive result. "0" indicates a negative result.

◆ mamaMsgQual_getIsDefinitelyDelayed()

MAMAExpDLL mama_status mamaMsgQual_getIsDefinitelyDelayed ( mamaMsgQual  msgQual,
int *  result 
)

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

Parameters
msgQualThe mamaMsgQual object.
result(out) Pointer to the result. "1" indicates a positive result. "0" indicates a negative result.

◆ mamaMsgQual_getIsPossiblyDelayed()

MAMAExpDLL mama_status mamaMsgQual_getIsPossiblyDelayed ( mamaMsgQual  msgQual,
int *  result 
)

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

Parameters
msgQualThe mamaMsgQual object.
result(out) Pointer to the result. "1" indicates a positive result. "0" indicates a negative result.

◆ mamaMsgQual_getIsOutOfSequence()

MAMAExpDLL mama_status mamaMsgQual_getIsOutOfSequence ( mamaMsgQual  msgQual,
int *  result 
)

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

Parameters
msgQualThe mamaMsgQual object.
result(out) Pointer to the result. "1" indicates a positive result. "0" indicates a negative result.

◆ mamaMsgQual_getValue()

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

Get the message qualifier value.

Parameters
msgQualThe mamaMsgQual object.
valueThe integer value of the message qualifier.

◆ mamaMsgQual_getAsString()

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.

Parameters
msgQualThe mamaMsgQual object.
delimiterThe delimiter to separate individual condition strings.
strThe string buffer to update.
maxLenThe maximum size of the string buffer (including trailing '\0').

◆ mamaMsgQual_valueToString()

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.

Parameters
valueThe value of the message qualifier.
delimiterThe delimiter to separate individual conditions strings.
strThe string buffer to update.
maxLenThe maximum size of the string buffer (including trailing '\0').


© 2012 Linux Foundation