getRuntimeVersion

Purpose
Returns a string containing version of CRTL and date on which it is built.
Declaration
mqstring getRuntimeVersion();
Include
Utils.h

DestroyHashtable

Purpose
Cleans the hashtable structure.
Declaration
void DestroyHashtable(Hashtable table);
Include
fiorano_hashtable.h
Parameters
Table
The hashtable that has to be destroyed

ES_free

Purpose
Frees all the memory associated with the exception stack trace.
Declaration
void ES_free();
Include
mq_errno.h

FBMSG_clearBody

Purpose
Clears the body of the bytes message. This does not include the message header and properties.
If this message body was read-only, calling this method leaves the message body in the same state as an empty body in a newly created message.
Declaration
mqboolean FBMSG_clearBody(BytesMessage msg);
Include
bytes_message.h
Parameters
Msg
BytesMessage
Return Values
Mqboolean
TRUE if successful, FALSE if an error occurs h1.FBMSG_readBoolean
Purpose
Reads an mqboolean from the bytes message stream.
Declaration
mqboolean FBMSG_readBoolean(BytesMessage msg, mqboolean* value);
Include
bytes_message.h
Paramaters
Msg
BytesMessage
value
Pointer to the mqboolean into which data is to be read
Return Value
Mqboolean
TRUE if successful, FALSE if error occurs

FBMSG_readByte

Purpose
Reads a signed 8-bit value from the bytes message stream.
Declaration
mqboolean FBMSG_readByte(BytesMessage msg, mqbyte* value);
Include
bytes_message.h
Parameters
Msg
BytesMessage
Value
Pointer to the mqbyte, into which the next byte from the bytes message stream is read as a signed 8-bit byte.
Return Values
Mqboolean
TRUE if successful, FALSE if error occurs

FBMSG_readBytes

Purpose
Reads an mqbyteArray of the specified length from the bytes message stream. If the length of array value is less than the number of bytes remaining to be read from the stream, the array should be filled. A subsequent call reads the next increment, and so on.
If the number of bytes remaining in the stream is less than the length of array value, the bytes should be read into the array. The return value of the total number of bytes read is less than the length of the array, indicating that there are no more bytes left to be read from the stream. The next read of the stream returns -1.
If length is negative, or length is greater than the length of the array value, then an OutOfBounds error is reported. For this exception case, no bytes are read from the stream.
mqint FBMSG_readBytes(BytesMessage msg, mqbyteArray value, mqint length);
Include
bytes_message.h
Parameters
Msg
BytesMessage
Value
mqbyteArray into which the data is to be read
length
Number of bytes to be read into "value", hence must be less than or equal to the length of "value"
Returns Value
Mqint
Number of bytes read, -1 if an error occurs

FBMSG_readChar

Purpose
Reads a Unicode character value from the bytes message stream
Declaration
mqboolean FBMSG_readChar(BytesMessage msg, mqchar* value);
Include
bytes_message.h
Parameters
Msg
BytesMessage
Value
Pointer to the mqchar, into which the next two bytes (java char) are read.
Mqboolean
TRUE if successful, FALSE if error occurs

FBMSG_readDouble

Purpose
Reads an mqdouble from the bytes message stream.
Declaration
mqboolean FBMSG_readDouble(BytesMessage msg, mqdouble* value);
Include
bytes_message.h
Parameters
msg
BytesMessage
Value
Pointer to the mqdouble, into which the next eight bytes of the bytes message stream are read and interpreted as mqdouble.
Return Values
mqboolean
TRUE if successful, FALSE if error occurs

FBMSG_readFloat

Purpose
Reads an mqfloat from the bytes message stream.
Declaration
mqboolean FBMSG_readFloat(BytesMessage msg, mqfloat* value);
Include
bytes_message.h
Parameters
msg
BytesMessage
Value
Pointer to the mqfloat, into which the next four bytes of the bytes message stream are read and interpreted as mqfloat.
Return Values
Mqboolean
TRUE if successful, FALSE if error occurs

FBMSG_readInt

Purpose
Reads a 32 bit signed integer (mqint) from the bytes message stream.
Declaration
mqboolean FBMSG_readInt(BytesMessage msg, mqint* value);
Include
bytes_message.h
Parameters
Msg
BytesMessage
Value
Pointer to the mqint, into which the next four bytes of the bytes message stream are read and interpreted as mqint.
Return Values
Mqboolean
TRUE if successful, FALSE if error occurs

FBMSG_readLong

Purpose
Reads a signed 64-bit integer (mqlong) from the bytes message stream.
Declaration
mqboolean FBMSG_readLong(BytesMessage msg, mqlong* value);
Include
bytes_message.h
Parameters
Msg
BytesMessage
Value
Pointer to mqlong, into which the next eight bytes are read from the bytes message stream, interpreted as mqlong.
Return Values
Mqboolean
TRUE if successful, FALSE if error occurs

FBMSG_readShort

Purpose
Reads an mqshort from the bytes message stream.
Declaration
mqboolean FBMSG_readShort(BytesMessage msg, mqshort* value);
Include
bytes_message.h
Parameters
Msg
BytesMessage
Value
Pointer to mqshort, into which the next two bytes from the bytes message stream, interpreted as a signed 16-bit number, are read.
Return Values
Mqboolean
TRUE if successful, FALSE if error occurs

FBMSG_readUnsignedByte

Purpose
Reads an unsigned 8-bit number from the bytes message stream.
Declaration
mqboolean FBMSG_readUnsignedByte(BytesMessage msg, mqint* value);
Include
bytes_message.h
Parameters
Msg
BytesMessage
Value
Pointer to the mqint, into which the next byte from the bytes message stream is read as an unsigned 8-bit number.
Return Values
Mqboolean
TRUE if successful, FALSE if error occurs

FBMSG_readUnsignedShort

Purpose
Reads an unsigned 16-bit number (mqshort) from the bytes message stream.
Declaration
mqboolean FBMSG_readUnsignedShort(BytesMessage msg, mqint* value);
Include
bytes_message.h
Parameters
Msg
BytesMessage
Value
Return Values
Mqboolean
TRUE if successful, FALSE if error occurs

FBMSG_readUTF

Purpose
Reads in mqstring that has been encoded using a modified UTF-8 format from the bytes message stream.
Declaration
mqstring FBMSG_readUTF(BytesMessage msg);
Include
bytes_message.h
Parameters
Msg
BytesMessage
Return Values
Mqstring
mqstring read from the bytes message, NULL if an error occurs

FBMSG_reset

Purpose
Puts the message body in read-only mode, and repositions the stream of bytes to the beginning.
Declaration
mqboolean FBMSG_reset(BytesMessage msg);
Include
bytes_message.h
Parameters
msg
BytesMessage
Return Values
Mqboolean
TRUE if successful, FALSE if error occurs

FBMSG_writeBoolean

Purpose
Writes an mqboolean to the bytes message stream as a 1-byte value. The value true is written as value 1; the value false is written as value 0.
Declaration
mqboolean FBMSG_writeBoolean(BytesMessage msg, mqboolean value);
Include
bytes_message.h
Parameters
Msg
BytesMessage
Value
mqboolean value to be written to the bytes message
Return Values
Mqboolean
TRUE if successful, FALSE if error occurs

FBMSG_writeByte

Purpose
Writes an mqbyte to the bytes message stream as a 1-byte value.
Declaration
mqboolean FBMSG_writeByte(BytesMessage msg, mqbyte value);
Include
bytes_message.h
Parameters
Msg
BytesMessage
Value
mqbyte value to be written to the bytes message
Return Values
Mqboolean
TRUE if successful, FALSE if error occurs

FBMSG_writeBytes

Purpose
Write an mqbyteArray to the bytes message stream.
Declaration
mqboolean FBMSG_writeBytes(BytesMessage msg, mqbyteArray value, mqint size);
Include
bytes_message.h
Parameters
Msg
BytesMessage
Value
mqbyteArray to be written to the bytes message
size
Size of the mqbyteArray
Return Values
Mqboolean
TRUE if successful, FALSE if error occurs

FBMSG_writeBytesWithOffset

Purpose
Writes a portion of mqbyteArray to the bytes message stream.
Declaration
mqboolean FBMSG_writeBytesWithOffset(BytesMessage msg, mqbyteArray value, mqint offset, mqint length);
Include
bytes_message.h
Parameters
Msg
BytesMessage
Value
mqbyteArray to be written to the bytes message
offset
Initial offset within the mqbyteArray
Length
Number of bytes to use
Return Values
Mqboolean
TRUE if successful, FALSE if error occurs

FBMSG_writeChar

Purpose
Writes an mqchar as 2 bytes to the bytes message stream.
Declaration
mqboolean FBMSG_writeChar(BytesMessage msg, mqchar value);
Include
bytes_message.h
Parameters
msg
BytesMessage
Value
mqchar value to be written to the bytes message
Return Values
Mqboolean
TRUE if successful, FALSE if error occurs

FBMSG_writeDouble

Purpose
Writes an mqdouble to the bytes message stream.
Declaration
mqboolean FBMSG_writeDouble(BytesMessage msg, mqdouble value);
Include
bytes_message.h
Parameters
Msg
BytesMessage
Value
mqdouble value to be written to the bytes message
Return Values
Mqboolean
TRUE if successful, FALSE if error occurs

FBMSG_writeFloat

Purpose
Writes an mqfloat to the bytes message stream.
Declaration
mqboolean FBMSG_writeFloat(BytesMessage msg, mqfloat value);
Include
bytes_message.h
Parameters
Msg
BytesMessage
Value
mqfloat value to be written to the bytes message
Return Values
Mqboolean
TRUE if successful, FALSE if error occurs

FBMSG_writeInt

Purpose
Writes an mqint to the bytes message stream.
Declaration
mqboolean FBMSG_writeInt(BytesMessage msg, mqint value);
Include
bytes_message.h
Parameters
Msg
BytesMessage
Value
mqint value to be written to the bytes message
Return Values
Mqboolean
TRUE if successful, FALSE if error occurs

FBMSG_writeLong

Purpose
Writes an mqlong to the bytes message stream.
Declaration
mqboolean FBMSG_writeLong(BytesMessage msg, mqlong value);
Include
bytes_message.h
Parameters
Msg
BytesMessage
Value
mqlong value to be written to the bytes message
Return Values
Mqboolean
TRUE if successful, FALSE if error occurs

FBMSG_writeShort

Purpose
Writes an mqshort to the bytes message stream.
Declaration
mqboolean FBMSG_writeShort(BytesMessage msg, mqshort value);
Include
bytes_message.h
Parameters
Msg
BytesMessage
Value
mqshort value to be written to the bytes message
Return Values
mqboolean
TRUE if successful, FALSE if error occurs

FBMSG_writeUTF

Purpose
Write an mqstring to the bytes message stream, using UTF-8 encoding in a machine-independent manner.
Declaration
mqboolean FBMSG_writeUTF(BytesMessage msg, mqstring value);
Include
bytes_message.h
Parameters
Msg
BytesMessage
Value
mqstring value to be written to the bytes message
Return Values
Mqboolean
TRUE if successful, FALSE if error occurs

FMMSG_clearBody

Purpose
Clears the contents of the message.
Declaration
mqboolean FMMSG_clearBody(MapMessage msg);
Include
map_message.h
Parameters
msg
MapMessage
Return Values
Mqboolean
TRUE if successful, FALSE if an error occurs

FMMSG_getBoolean

Purpose
Gets the mqboolean value with the given name.
Declaration
mqboolean FMMSG_getBoolean(MapMessage msg, mqstring name, mqboolean* value);
Include
map_message.h
Parameters
Msg
MapMessage
Name
Name of the mqboolean
Value
Pointer to the mqboolean, into which data is to be read
Return Values
Mqboolean
TRUE if successful, FALSE if error occurs

FMMSG_getByte

Purpose
Gets the mqbyte value with the given name.
Declaration
mqboolean FMMSG_getByte(MapMessage msg, mqstring name, mqbyte* value);
Include
map_message.h
Parameters
Msg
MapMessage
name
Name of the mqbyte
Value
Pointer to the mqbyte, into which data is to be read
Return Values
Mqboolean
TRUE if successful, FALSE if error occurs

FMMSG_getBytes

Purpose
Gets the mqbyteArray with the given name.
Declaration
mqint FMMSG_getBytes(MapMessage msg, mqstring name, mqbyteArray bArray, mqint length);
Include
map_message.h
Parameters
Msg
MapMessage
Name
Name of the mqbyteArray
bArray
value
Size of the specified mqbyteArray
Return Values
Mqint
Number of bytes read, -1 if no byte is read

FMMSG_getChar

Purpose
Gets the mqchar value with the given name.
Declaration
mqboolean FMMSG_getChar(MapMessage msg, mqstring name, mqchar* value);
Include
map_message.h
Parameters
Msg
MapMessage
Name
Name of the mqchar
Value
Pointer to the mqchar, into which data is to be read
Return Values
Mqboolean
TRUE if successful, FALSE if an error occurs

FMMSG_getDouble

Purpose
Gets the mqdouble value with the given name.
Declaration
mqboolean FMMSG_getDouble(MapMessage msg, mqstring name, mqdouble* value);
Include
map_message.h
Parameters
Msg
MapMessage
Name
Name of the mqdouble
Value
Pointer to the mqdouble, into which data is to be read
Return Values
Mqboolean
TRUE if successful, FALSE if an error occurs

FMMSG_getFloat

Purpose
Gets the mqfloat value with the given name.
Declaration
mqboolean FMMSG_getFloat(MapMessage msg, mqstring name, mqfloat* value);
Include
map_message.h
Parameters
Msg
MapMessage
Name
Name of the mqfloat
Value
Pointer to the mqfloat, into which data is to be read
Return Values
Mqboolean
TRUE if successful, FALSE if an error occurs

FMMSG_getInt

Purpose
Gets the mqint value with the given name.
Declaration
mqboolean FMMSG_getInt(MapMessage msg, mqstring name, mqint* value);
Include
map_message.h
Parameters
Msg
MapMessage
Name
Name of the mqint
Value
Pointer to the mqint, into which data is to be read
Return Values
Mqboolean
TRUE if successful, FALSE if an error occurs

FMMSG_getLong

Purpose
Gets the mqlong value with the given name.
Declaration
mqboolean FMMSG_getLong(MapMessage msg, mqstring name, mqlong* value);
Include
map_message.h
Parameters
Msg
MapMessage
Name
Name of the mqlong
Value
Pointer to the mqlong, into which data is to be read
Return Values
Mqboolean
TRUE if successful, FALSE if error occurs

FMMSG_getMapNames

Purpose
Gets an array of all the map names.
Declaration
mqint FMMSG_getMapNames(MapMessage msg, mqstring** namesPointer);
Include
map_message.h
Parameters
Msg
MapMessage
namesPointer
Pointer to an array of strings, into which the map names are set
Return Values
Mqint
Number of map names, -1 if an error occurs

FMMSG_getShort

Purpose
Gets the mqshort value with the given name.
Declaration
mqboolean FMMSG_getShort(MapMessage msg, mqstring name, mqshort* value);
Include
map_message.h
Parameters
Msg
MapMessage
Name
Name of the mqshort
Value
Pointer to the mqshort, into which data is to be read
Return Values
Mqboolean
TRUE if successful, FALSE if an error occurs

FMMSG_getString

Purpose
Gets the mqstring value with the given name.
Declaration
mqstring FMMSG_getString(MapMessage msg, mqstring name);
Include
map_message.h
Parameters
Msg
MapMessage Name of the mqstring
Return Values
Mqstring
mqstring with the give name, NULL if there is no item by this name

FMMSG_itemExists

Purpose
Checks if an item with the given name exists in this MapMessage.
Declaration
mqboolean FMMSG_itemExists(MapMessage msg, mqstring name);
Include
map_message.h
Parameters
Msg
MapMessage
Name
Name of the item
Return Values
Mqboolean
TRUE if the value exists; false otherwise

FMMSG_setBoolean

Purpose
Sets the mqboolean value with the given name.
Declaration
mqboolean FMMSG_setBoolean(MapMessage msg, mqstring name, mqboolean value);
Include
map_message.h
Parameters
Msg
MapMessage
Name
Name of the mqboolean
Value
mqboolean value to be set in the map
Return Values
Mqboolean
TRUE if successful, FALSE if an error occurs

FMMSG_setByte

Purpose
Sets the mqbyte value with the given name.
Declaration
mqboolean FMMSG_setByte(MapMessage msg, mqstring name, mqbyte value);
Include
map_message.h
Parameters
Msg
MapMessage
Name
Name of the mqbyte
Value
mqbyte value to be set in the map
Return Values
mqboolean

FMMSG_setBytes

Purpose
Sets the mqbyteArray with the given name.
Declaration
mqboolean FMMSG_setBytes(MapMessage msg, mqstring name, mqbyteArray value, mqint length);
Include
map_message.h
Parameters
Msg
MapMessage
Name
Name of the mqboolean
Value
mqbyteArray value to be set in the map
length
Size of the specified mqbyteArray
Return Values
Mqboolean
TRUE if successful, FALSE if an error occurs

FMMSG_setBytesWithOffset

Purpose
Sets a portion of mqbyteArray with the given name.
Declaration
mqboolean FMMSG_setBytesWithOffset(MapMessage msg, mqstring name, mqbyteArray value, mqint offset, mqint length);
Includes
map_message.h
Parameters
Msg
MapMessage
Name
Name of the mqboolean
Value
mqbyteArray value to be set in the map
offset
Initial offset within the mqbyteArray
Length
Number of bytes to be used
Return Values
Mqboolean
TRUE if successful, FALSE if an error occurs

FMMSG_setChar

Purpose
Sets the mqchar value with the given name.
Declaration
mqboolean FMMSG_setChar(MapMessage msg, mqstring name, mqchar value);
Include
map_message.h
Parameters
Msg
MapMessage
Name
Name of the mqchar
Value
mqchar value to be set in the map
Return Values
Mqboolean
TRUE if successful, FALSE if an error occurs

FMMSG_setDouble

Purpose
Sets the mqdouble value with the given name.
Declaration
mqboolean FMMSG_setDouble(MapMessage msg, mqstring name, mqdouble value);
Include
map_message.h
Parameters
Msg
MapMessage
Name
Name of the mqdouble
Value
mqdouble value to be set in the map
Return Values
Mqboolean
TRUE if successful, FALSE if an error occurs

FMMSG_setFloat

Purpose
Sets the mqfloat value with the given name.
Declaration
mqboolean FMMSG_setFloat(MapMessage msg, mqstring name, mqfloat value);
Include
map_message.h
Parameters
Msg
MapMessage
Name
Name of the mqfloat
Value
mqfloat value to be set in the map
Return Values
Mqboolean
TRUE if successful, FALSE if an error occurs

FMMSG_setInt

Purpose
Sets the mqint value with the given name.
Declaration
mqboolean FMMSG_setInt(MapMessage msg, mqstring name, mqint value);
Include
map_message.h
Parameters
Msg
MapMessage
Name
Name of the mqint
Value
mqint value to be set in the map
Return Values
Mqboolean
TRUE if successful, FALSE if an error occurs

FMMSG_setLong

Purpose
Sets the mqlong value with the given name.
Declaration
mqboolean FMMSG_setLong(MapMessage msg, mqstring name, mqlongvalue);
Include
map_message.h
Parameters
Msg
MapMessage
Name
Name of the mqlong
Value
mqlong value to be set in the map
Return Values
Mqboolean
TRUE if successful, FALSE if an error occurs

FMMSG_setShort

Purpose
Sets the mqshort value with the given name.
Declaration
mqboolean FMMSG_setShort(MapMessage msg, mqstring name, mqshort value);
Include
map_message.h
Parameters
Msg
MapMesage
name
Name of the mqshort
Value
mqshort value to be set in the map
Return Values
Mqboolean
TRUE if successful, FALSE if an error occurs

FMMSG_setString

Purpose
Sets the mqstring value with the given name.
Declaration
mqboolean FMMSG_setString(MapMessage msg, mqstring name, mqstringvalue);
Include
map_message.h
Parameters
Msg
MapMessage
Name
Name of the mqstring
Value
mqstring value to be set in the map
Return Values
Mqboolean
TRUE if successful, FALSE if an error occurs

FSMSG_clearBody

Purpose
Clears the contents of the stream message.
Declaration
mqboolean FSMSG_clearBody(StreamMessage msg);
Include
stream_message.h
Parameters
Msg
StreamMessage that is to be cleared.
Return Values
Mqboolean
TRUE if successful, FALSE if an error occurs

FSMSG_readBoolean

Purpose
Reads an mqboolean from the stream message.
Declaration
mqboolean FSMSG_readBoolean(StreamMessage msg, mqboolean *value);
Include
stream_message.h
Parameters
Msg
StreamMessage
Value
Pointer to the mqboolean, into which data is read
Return Values
Mqboolean
TRUE if successful, FALSE if an error occurs

FSMSG_readByte

Purpose
Reads an mqbyte from the stream message.
Declaration
mqboolean FSMSG_readByte(StreamMessage msg, mqbyte *value);
Include
stream_message.h
Parameters
Msg
StreamMessage
Value
Pointer to the mqbyte, into which the next byte from the stream message (as a 8bit byte) is read.
Return Values
Mqboolean
TRUE if successful, FALSE if an error occurs

FSMSG_readBytes

Purpose
Reads an mqbyteArray from the stream message.
To read the field value, readBytes should be successively called until it returns a value less than the length of the read buffer. The value of the bytes in the buffer following the last byte read is undefined.
If readBytes returns a value equal to the length of the buffer, a subsequent read Bytes call must be made. If there are no more bytes to be read, this call returns -1.
If the byte array field value is null, readBytes returns -1. If the byte array field value is empty, readBytes returns 0.
Once the first readBytes call on a byte[] field value has been made, the full value of the field must be read before it is valid to read the next field. An attempt to read the next field before that has been done leads to an error.
Declaration
mqint FSMSG_readBytes(StreamMessage msg, mqbyteArray value, mqintlength);
Include
stream_message.h
Parameters
Msg
StreamMessage
Value
mqbyteArray into which the data is read
length
Size of the mqbyteArray
Return Values
Mqint
Number of bytes read

FSMSG_readChar

Purpose
Reads an mqchar from the stream message.
Declaration
mqboolean FSMSG_readChar(StreamMessage msg, mqchar *value);
Include
stream_message.h
Parameters
Msg
StreamMessage
Value
Pointer to the mqchar, into which the unicode character are read
Return Values
Mqboolean
TRUE if successful, FALSE if an error occurs

FSMSG_readDouble

Purpose
Reads an mqdouble from the stream message.
Declaration
mqboolean FSMSG_readDouble(StreamMessage msg, mqdouble *value);
Include
stream_message.h
Parameters
Msg
StreamMessage
Value
Pointer to the mqdouble, into which data is read
Return Values
Mqboolean
TRUE if successful, FALSE if an error occurs

FSMSG_readFloat

Purpose
Reads an mqfloat from the stream message.
Declaration
mqboolean FSMSG_readFloat(StreamMessage msg, mqfloat *value);
Include
stream_message.h
Parameters
Msg
StreamMessage
Value
Pointer to the mqfloat, into which data is read
Return Values
Mqboolean
TRUE if successful, FALSE if an error occurs

FSMSG_readInt

Purpose
Reads an mqint from the stream message.
Declaration
mqboolean FSMSG_readInt(StreamMessage msg, mqint *value);
Include
stream_message.h
Parameters
Msg
StreamMessage
Value
Pointer to the mqint, into which data is read
Return Values
Mqboolean
TRUE if successful, FALSE if an error occurs

FSMSG_readLong

Purpose
Reads an mqlong from the stream message.
Declaration
mqboolean FSMSG_readLong(StreamMessage msg, mqlong *value);
Include
stream_message.h
Parameters
Msg
StreamMessage
value
Pointer to the mqlong, into which data is read
Return Values
Mqboolean
TRUE if successful, FALSE if an error occurs

FSMSG_readShort

Purpose
Reads an mqshort from the stream message.
Declaration
mqboolean FSMSG_readShort(StreamMessage msg, mqshort *value);
Include
stream_message.h
Parameters
Msg
StreamMessage
Value
Pointer to the mqshort, into which data is read
Return Values
Mqboolean
TRUE if successful, FALSE if an error occurs

FSMSG_readString

Purpose
Reads an mqstring from the stream message.
Declaration
mqstring FSMSG_readString(StreamMessage msg);
Include
stream_message.h
Parameters
Msg
StreamMessage
Return Values
Mqstring
mqstring from the stream message, NULL if an error occurs

FSMSG_reset

Purpose
Puts the message body in read-only mode, and repositions the stream to the beginning.
Declaration
mqboolean FSMSG_reset(StreamMessage msg);
Include
stream_message.h
Parameters
Msg
StreamMessage
Return Values
Mqboolean
TRUE if successful, FALSE if an error occurs

FSMSG_writeBoolean

Purpose
Writes an mqboolean to the stream message, as a 1-byte value.
Declaration
mqboolean FSMSG_writeBoolean(StreamMessage msg, mqboolean value);
Include
stream_message.h
Parameters
Msg
StreamMessage
Value
mqboolean to be written
Return Values
Mqboolean
TRUE if successful, FALSE if an error occurs

FSMSG_writeByte

Purpose
Writes an mqbyte to the stream message.
Declaration
mqboolean FSMSG_writeByte(StreamMessage msg, mqbyte value);
Include
stream_message.h
Parameters
Msg
StreamMessage
Value
mqbyte to be written
Return Values
Mqboolean
TRUE if successful, FALSE if an error occurs

FSMSG_writeBytes

Purpose
Writes an mqbyteArray to the stream message. The byte array value is written to the message as a byte array field. Consecutively written byte array fields are treated as two distinct fields when the fields are read.
Declaration
mqboolean FSMSG_writeBytes(StreamMessage msg, mqbyteArray value, mqint length);
Include
stream_message.h
Parameters
Msg
StreamMessage
Value
mqbyteArray to be written
length
Size of the mqbyteArray
Return Values
Mqboolean
TRUE if successful, FALSE if an error occurs

FSMSG_writeBytesWithOffset

Purpose
Writes a portion of an mqbyteArray to the stream message. The portion of byte array value is written to the message as a byte array field. Consecutively written byte array fields are treated as two distinct fields when the fields are read.
Declaration
mqboolean FSMSG_writeBytesWithOffset(StreamMessage msg, mqbyteArray value, mqint offset, mqint length);
Include
stream_message.h
Parameter
msg
StreamMessage
Value
mqbyteArray to be written
offset
Initial offset in the mqbyteArray
Length
Size of the mqbyteArray
Return Values
Mqboolean
TRUE if successful, FALSE if an error occurs

FSMSG_writeChar

Purpose
Writes an mqchar to the stream message.
Declaration
mqboolean FSMSG_writeChar(StreamMessage msg, mqchar value);
Include
stream_message.h
Parameters
Msg
StreamMessage
Value
mqchar to be written
Return Values
Mqboolean
TRUE if successful, FALSE if an error occurs

FSMSG_writeDouble

Purpose
Writes an mqdouble to the stream message.
Declaration
mqboolean FSMSG_writeDouble(StreamMessage msg, mqdouble value);
Include
stream_message.h
Parameters
Msg
StreamMessage
Value
mqdouble to be written
Return Values
Mqboolean
TRUE if successful, FALSE if an error occurs

FSMSG_writeFloat

Purpose
Writes an mqfloat to the stream message.
Declaration
mqboolean FSMSG_writeFloat(StreamMessage msg, mqfloat value);
Include
stream_message.h
Parameters
Msg
StreamMessage
value
mqfloat to be written
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

FSMSG_writeInt

Purpose
Writes an mqint to the stream message.
Declaration
mqboolean FSMSG_writeInt(StreamMessage msg, mqint value);
Include
stream_message.h
Parameters
Msg
StreamMessage
Value
mqint to be written
Return Values
Mqboolean
TRUE if successful, FALSE if an error occurs

FSMSG_writeLong

Purpose
Writes an mqlong to the stream message.
Declaration
mqboolean FSMSG_writeLong(StreamMessage msg, mqlong value);
Include
stream_message.h
Parameters
Msg
StreamMessage
value
mqlong to be written
Return Values
Mqboolean
TRUE if successful, FALSE if an error occurs

FSMSG_writeShort

Purpose
Writes an mqshort to the stream message.
Declaration
mqboolean FSMSG_writeShort(StreamMessage msg, mqshort value);
Include
stream_message.h
Parameters
Msg
StreamMessage
Value
mqshort to be written
Return Values
Mqboolean
TRUE if successful, FALSE if an error occurs

FSMSG_writeString

Purpose
Writes an mqstring to the stream message.
Declaration
mqboolean FSMSG_writeString(StreamMessage msg, mqstring value);
Include
stream_message.h
Parameters
Msg
StreamMessage
Value
mqstring to be written
Return Values
Mqboolean
TRUE if successful, FALSE if an error occurs

FTMSG_getText

Purpose
Gets the string containing data of this message.
Declaration
mqstring FTMSG_getText(TextMessage msg);
Include
text_message.h
Parameters
Msg
TextMessage
Return Values
Mqstring
mqstring containing data of this message

FTMSG_setText

Purpose
Sets the string containing data of this message.
Declaration
mqboolean FTMSG_setText(TextMessage msg, mqstring string);
Include
text_message.h
Parameters
Msg
TextMessage
String
The mqstring containing data of this message
Return Values
Mqboolean
TRUE if successful, FALSE if an error occurs

HT_Clear

Purpose
Clears this hashtable so that it contains no keys and/or elements. This API would clear a hashtable, which only has values of type mqstring.
Declaration
void HT_Clear(Hashtable table, mqboolean keyFlag);
Include
fiorano_hashtable.h
Parameters
Table
The hashtable that has to be cleared
keyFlag
True if both keys and values have to be cleared, false if only the values have to be cleared. h1.HT_ContainsKey
Purpose
Tests if the specified mqstring is a key in this hashtable.
Declaration
mqboolean HT_ContainsKey(Hashtable table, mqstring key);
Include
fiorano_hashtable.h
Parameters
Table
The hashtable for which the key has to be checked
Key
The possible hashtable key as mqstring
Return Values
Mqboolean
True if and only if the specified object is a key in this hashtable, false otherwise. h1.HT_ContainsValue
Purpose
Returns true if this hashtable maps one or more keys to this value.
Declaration
mqboolean HT_ContainsValue(Hashtable table, mqobject value);
Include
fiorano_hashtable.h
Parameters
Table
The hashtable for which the value has to be checked
Value
The hashtable value as mqobject
Return Values
Mqboolean
True if this hashtable maps one or more keys to the specified value.

HT_Get

Purpose
Returns the value to which the specified key is mapped in this hashtable.
Declaration
mqobject HT_Get(Hashtable table, mqstring key);
Include
fiorano_hashtable.h
Parameters
Table
The hashtable from which the value has to be retrieved
Key
The hashtable key as mqstring
Return Values
Mqobject
The preceding value of the specified key in this hashtable, or NULL if it does not hold one.

HT_IsEmpty

Purpose
Tests if this hashtable maps no keys to values.
Declaration
mqobject HT_IsEmpty(Hashtable table);
Include
fiorano_hashtable.h
table
The hashtable to be checked
Return Values
Mqboolean
True if this hashtable maps no keys to values; false otherwise

HT_Put

Purpose
Maps the specified key to the specified value in the argument hashtable. Neither the key nor the value can be NULL. The value can be retrieved by calling the get method with a key that is equal to the original key.
Declaration
mqobject HT_Put(Hashtable table, mqstring key, mqobject val-ue);
Include
fiorano_hashtable.h
Parameters
Table
The hashtable to which a name-value pair has to be added
Key
The hashtable key
Value
Value to be stored in the hashtable for the specified key
Return Values
Mqobject
The preceding value of the specified key in this hashtable, or NULL if it does not hold one. h1.HT_RemoveElement
Purpose
Removes the key (and its corresponding value) from this hashtable. This method does nothing if the key is not present in the hashtable.
Declaration
mqobject HT_RemoveElement(Hashtable table, mqstring key);
Include
fiorano_hashtable.h
Parameters
Table
The hashtable from which the value has to be removed
Key
The hashtable key that has to be removed
Return Values
Mqobject
The value to which the key had been mapped in this hashtable, null if the key does not hold a mapping.

HT_Size

Purpose
Returns the number of keys in this hashtable.
Declaration
mqint HT_Size(Hashtable table);
Include
fiorano_hashtable.h
Parameters
Table
The hashtable whose size has to be returned

IC_ Free

Purpose
Frees up the resources allocated to the initial context structure.
Declaration
void IC_free(InitialContext ic);
Include
initial_context.h
Parameters
Ic
The InitialContext that has to be cleaned up

IC_Lookup

Purpose
Lookup an administered object from FioranoMQ server with name of the object passed as argument.
Declaration
mqobject IC_Lookup(InitialContext ic, mqstring adminObjectName);
Include
initial_context.h
Parameters
Ic
The InitialContext to used for lookup
adminObjectName
Name of the admin object to lookup
Return Values
Mqobject
The admin object, in the form of mqobject

IC_LookupQCF

Purpose
Lookup an Queue Connection Factory object from FioranoMQ server with name of the object passed as argument. This is used for server less mode. If server is present, it looks up as normal Lookup function.
Declaration
mqobject IC_LookupQCF(InitialContext ic, mqstring adminObjectName);
Include
initial_context.h
Parameters
ic
The InitialContext to used for lookup
adminObjectName
Name of the admin object to lookup
Return Values
Mqobject
The admin object, in the form of mqobject

IC_LookupTCF

Purpose
Lookup an administered object from FioranoMQ server with name of the object passed as argument. This is used for server less mode. If server is present, it looks up as normal Lookup function.
Declaration
mqobject IC_LookupTCF(InitialContext ic, mqstring adminObjectName);
Include
initial_context.h
Parameters
ic
The InitialContext to used for lookup
adminObjectName
Name of the admin object to lookup
Return Values
Mqobject
The admin object, in the form of mqobject

MqExceptionClear

Purpose
Clears information about the last occurred exception.
Declaration
void MqExceptionClear ();
Include
mq_errno.h

MqExceptionOccurred

Purpose
Checks if any exception or error occurred in any operations performed before the execution of this API.
Declaration
mqboolean MqExceptionOccurred ();
Include
mq_errno.h
Return Values
True if an exception or error occurred; false otherwise

MqGetLastErrCode

Purpose
Returns the error code of the last occurred exception.
Declaration
mqint MqGetLastErrCode ();
Include
mq_errno.h
Return Values
Error code of the last occurred error, as mqint

MqPrintException

Purpose
Prints the exception stack to stdout.
Declaration
void MqPrintException();
Include
mq_errno.h

MqPrintExceptionToBuffer

Purpose
Fills the exception stack trace into a pre-allocated buffer.
Declaration
int MqPrintExceptionToBuffer(char* buffer, int size);
Include
mq_errno.h
Parameters
char*
Pre-allocated buffer into which the exception stack has to be read
int
Size of the pre-allocated buffer
Return
Returns the size of the exception stack trace

MSG_acknowledge

Purpose
Acknowledges all consumed messages of the session of this consumed message.
All consumed JMS messages support the acknowledge method for use when a client has specified that consumed messages of its JMS session are to be explicitly acknowledged. By invoking acknowledge on a consumed message, a client acknowledges all messages consumed by the session that the message was delivered to.
Calls to acknowledge are ignored for both transacted sessions and sessions specified to use implicit acknowledgement modes.
A client may individually acknowledge each message as it is consumed, or it may choose to acknowledge messages as an application-defined group (which is done by calling acknowledge on the last received message of the group, thereby acknowledging all messages consumed by the session).
Messages that have been received but not acknowledged may be redelivered.
Declaration
mqboolean MSG_acknowledge(Message msg);
Include
message.h
Parameters
msg
Message
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

MSG_clearBody

Purpose
Clears out the message body. Clearing the body of a message does not clear its header values or property entries.
Declaration
mqboolean MSG_clearBody(Message msg);
Include
message.h
Parameters
msg
Message
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

MSG_clearProperties

Purpose
Clears the properties of the message. The message header fields and body are not cleared.
Declaration
mqboolean MSG_clearProperties(Message msg);
Include
message.h
Parameters
msg
Message
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

MSG_free

Purpose
Frees the resources allocated for the message. This API is to be used to free all message types.
Declaration
void MSG_free(Message msg);
Include
message.h
Parameters
msg
Message

MSG_getBooleanProperty

Purpose
Gets the mqboolean property value with the given name.
Declaration
mqboolean MSG_getBooleanProperty(Message msg, mqstring propName,
mqboolean *value);
Include
message.h
Parameters
msg
Message
propName
Name of the mqboolean property
value
Pointer to mqboolean, into which the mqboolean property is to be read
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

MSG_getByteProperty

Purpose
Gets the mqbyte property value with the given name.
Declaration
mqboolean MSG_getByteProperty(Message msg, mqstring propName,
mqbyte *value);
Include
message.h
Parameters
msg
Message
propName
Name of the mqbyte property
value
Pointer to mqbyte, into which the mqbyte property is to be read
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

MSG_getDoubleProperty

Purpose
Gets the mqdouble property value with the given name.
Declaration
mqboolean MSG_getDoubleProperty(Message msg, mqstring propName,
mqdouble *value);
Include
message.h
Parameters
msg
Message
propName
Name of the mqdouble property
Value
Pointer to mqdouble, into which the mqdouble property is to be read
Return Values
Mqboolean
TRUE if successful, FALSE if an error occurs

MSG_getFloatProperty

Purpose
Gets the mqfloat property value with the given name.
Declaration
mqboolean MSG_getFloatProperty(Message msg, mqstring propName,
mqfloat *value);
Include
message.h
Parameters
msg
Message
propName
Name of the mqfloat property
value
Pointer to mqfloat, into which the mqfloat property is to be read
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

MSG_getIntProperty

Purpose
Gets the mqint property value with the given name.
Declaration
mqboolean MSG_getIntProperty(Message msg, mqstring propName, mqint *value);
message.h
Parameters
msg
Message
propName
Name of the mqint property
value
Pointer to mqint, into which the mqint property is to be read
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

MSG_getJMSCorrelationID

Purpose
Gets the correlation ID of the message as mqstring.
Declaration
mqstring MSG_getJMSCorrelationID(Message msg);
Include
message.h
Parameters
msg
Message
Return Values
mqstring
Correlation ID of the message, NULL if an error occurs

MSG_getJMSCorrelationIDAsBytes

Purpose
Gets the correlation ID of the message as mqbyteArray.
Declaration
mqint MSG_getJMSCorrelationIDAsBytes(Message msg, mqbyteArray *cor-relationID);
Include
message.h
Parameters
msg
Message
correlationID
mqbyteArray where the correlationID has to be set
Return Values
mqint
Length of the mqbyteArray, -1 if an error occurs

MSG_getJMSDeliveryMode

Purpose
Gets the delivery mode for this message.
Declaration
mqboolean MSG_getJMSDeliveryMode(Message msg, mqint *value);
Include
message.h
Parameters
msg
Message
value
Pointer to the mqint, into which the delivery mode is to be read
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

MSG_getJMSDestination

Purpose
Gets the destination for this message.
Declaration
struct _Destination* MSG_getJMSDestination(Message msg);
Include
message.h
Parameters
msg
Message
Return Values
struct _Destination*
Destination of the message

MSG_getJMSExpiration

Purpose
Gets the expiration time of the message.
Declaration
mqboolean MSG_getJMSExpiration(Message msg, mqlong *value);
Include
message.h
Parameters
msg
Message
value
Pointer to mqlong, into which the message expiration time is to be read
Return Values
mqboolean

MSG_getJMSMessageID

Purpose
Gets the message ID for this message.
Declaration
mqstring MSG_getJMSMessageID(Message msg);
Include
message.h
Parameters
msg
Message
Return Values
mqstring
Message ID as mqstring

MSG_getJMSPriority

Purpose
Gets the message priority.
Declaration
mqboolean MSG_getJMSPriority(Message msg, mqint *value);
Include
message.h
Parameters
msg
Message
value
Pointer to mqint, into which the message priority is to be read
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

MSG_getJMSRedelivered

Purpose
Gets an indication of redelivery of this message.
Declaration
mqboolean MSG_getJMSRedelivered(Message msg, mqboolean *value);
Include
message.h
Parameters
msg
Message
value
Pointer to mqboolean, into which the redelivered flag is set
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

MSG_getJMSReplyTo

Purpose
Gets the destination structure to which a reply to this message should be sent.
Declaration
struct _Destination* MSG_getJMSReplyTo(Message msg);
Include
message.h
Parameters
msg
Return Values
struct _Destination*
Destination object, where a response to this message is to be sent

MSG_getJMSTimestamp

Purpose
Gets the message timestamp for this message.
Declaration
mqboolean MSG_getJMSTimestamp(Message msg, mqlong *value);
Include
message.h
Parameters
msg
Message
value
Pointer to the mqlong, into which timestamp is to be read
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

MSG_getJMSType

Purpose
Gets the message type.
Declaration
mqstring MSG_getJMSType(Message msg);
Include
message.h
Parameters
msg
Message
Return Values
mqstring
Message type as an mqstring

MSG_getLongProperty

Purpose
Gets the mqlong property value with the given name.
Declaration
mqboolean MSG_getLongProperty(Message msg, mqstring propName, mqlong *value);
Include
message.h
Parameters
msg
Message
propName
Name of the mqlong property
value
Pointer to mqlong, into which the mqlong property is to be read
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

MSG_getObjectProperty

Purpose
Gets an Object Property from the message.
Declaration
mqobject MSG_getObjectProperty(Message msg, mqstring propName);
Include
message.h
Parameters
msg
Message from which the property is to be read
propName
Name of the property
Return Values
mqobject
The mqobject property

MSG_getPropertyNames

Purpose
Gets an array of all the property names.
Declaration
mqint MSG_getPropertyNames(Message msg, mqstring** list);
Include
message.h
Parameters
msg
Message
list
Pointer to an array of strings, into which the property names are set
Return Values
mqint
Number of properties, -1 if an error occurs

MSG_getShortProperty

Purpose
Gets the mqshort property value with the given name.
Declaration
mqboolean MSG_getShortProperty(Message msg, mqstring propName, mqshort *value);
Include
message.h
Parameters
msg
Message
propName
Name of the mqshort property
value
Pointer to mqshort, into which the mqshort property is to be read
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

MSG_getStringProperty

Purpose
Gets the mqstring property value with the given name. The api internally allocates memory for the mqstring property value and returns it to the application. The allocated memory should be freed up in the client application.
Example:
mqstring qmMsgType = MSG_getStringProperty(bytesMsg,"MESSAGE_TYPE1"); mqfree(qmMsgType);
Declaration
mqstring MSG_getStringProperty(Message msg, mqstring propName);
Include
message.h
Parameters
msg
Message Name of the mqstring property
Return Values
mqstring
mqstring property with the given name, NULL if it does not exists

MSG_propertyExists

Purpose
Checks if a property value exists.
Declaration
mqboolean MSG_propertyExists(Message msg, mqstring propName, mqboolean *value);
Include
message.h
Parameters
msg
Message
propName
Name of the property to test
value
Pointer to mqboolean, which is used to report whether or not the property exists
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

MSG_setBooleanProperty

Purpose
Sets an mqboolean property value, into the Message, with the given name.
Declaration
mqboolean MSG_setBooleanProperty(Message msg, mqstring propName, mqboolean propValue);
Include
message.h
Parameters
msg
Message
propName
Name of the mqboolean property
propValue
mqboolean property value to set in the message
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

MSG_setByteProperty

Purpose
Sets an mqbyte property value, into the Message, with the given name.
Declaration
mqboolean MSG_setByteProperty(Message msg, mqstring propName, mqbyte propValue);
Include
message.h
Parameters
msg
Message
propName
Name of the mqbyte property
propValue
mqbyte property value to set in the message
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

MSG_setDoubleProperty

Purpose
Sets an mqdouble property value, into the Message, with the given name.
Declaration
mqboolean MSG_setDoubleProperty(Message msg, mqstring propName, mqdouble propValue);
Include
message.h
Parameters
msg
Message
propName
Name of the mqdouble property
propValue
mqdouble property value to set in the message
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

MSG_setFloatProperty

Purpose
Sets an mqfloat property value, into the Message, with the given name.
Declaration
mqboolean MSG_setFloatProperty(Message msg, mqstring propName, mqfloat propValue);
message.h
Parameters
msg
Message
propName
Name of the mqfloat property
propValue
mqfloat property value to set in the message
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

MSG_setIntProperty

Purpose
Sets an mqint property value, into the Message, with the given name.
Declaration
mqboolean MSG_setIntProperty(Message msg, mqstring propName, mqint propValue);
Include
message.h
Parameters
msg
Message
propName
Name of the mqint property
propValue
mqint property value to set in the message
Return Values
mqboolean

MSG_setJMSCorrelationID

Purpose
Sets the correlation ID for this message.
Declaration
mqboolean MSG_setJMSCorrelationID(Message msg, mqstring correla-tionID);
Include
message.h
Parameters
msg
Message
correlationID
Correlation ID to be set for the message, specified as mqstring
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

MSG_setJMSCorrelationIDAsBytes

Purpose
Sets the correlation ID for this message as mqbyteArray.
Declaration
mqboolean MSG_setJMSCorrelationIDAsBytes(Message msg, mqbyteArray correlationID, mqint length);
Include
message.h
Parameters
msg
Message Correlation ID to be set for the message, specified as mqbytearray
length
Size of the mqbyteArray correlationID
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

MSG_setJMSDeliveryMode

Purpose
Sets the delivery mode for this message.
Declaration
mqboolean MSG_setJMSDeliveryMode(Message msg, mqint mode);
Include
message.h
Parameters
msg
Message
mode
The delivery mode for this message
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

MSG_setJMSDestination

Purpose
Sets the destination for this message.
Declaration
mqboolean MSG_setJMSDestination(Message msg, struct _Destination*dest);
Includes
message.h
Parameters
msg
Message
dest
Destination for this message
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

MSG_setJMSExpiration

Purpose
Sets the expiration value of the message. This API is used only by FioranoMQ C-rtl to set the expiration time of the message.
Declaration
mqboolean MSG_setJMSExpiration(Message msg, mqlong expiration);
Include
message.h
Parameters
msg
Message
expiration
Expiration time of the message
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

MSG_setJMSMessageID

Purpose
Sets the message ID for this message.
Declaration
mqboolean MSG_setJMSMessageID(Message msg, mqstring str);
Include
message.h
Parameters
msg
Message
str
ID of the message
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

MSG_setJMSPriority

Purpose
Sets the priority for this message.
Declaration
mqboolean MSG_setJMSPriority(Message msg, mqint priority);
Include
message.h
Parameters
msg
Message
priority
The priority of this message specified as mqint
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

MSG_setJMSRedelivered

Purpose
Set to indicate whether this message is being redelivered.
Declaration
mqboolean MSG_setJMSRedelivered(Message msg, mqboolean redelivered);
Include
message.h
Parameters
msg
Message
redelivered
TRUE if the message is being redelivered, FALSE otherwise
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

MSG_setJMSReplyTo

Purpose
Sets the destination, where a reply to this message should be sent.
Declaration
mqboolean MSG_setJMSReplyTo(Message msg, struct _Destination*replyTo);
Include
message.h
Parameters
msg
Message
struct _Destination*
replyTo destination structure to which the response should be sent
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

MSG_setJMSTimestamp

Purpose
Sets the message timestamp as mqlong.
Declaration
mqboolean MSG_setJMSTimestamp(Message msg, mqlong timeStamp);
Include
message.h
Parameters
msg
Message
timeStamp
Timestamp for this message, specified as mqlong
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

MSG_setJMSType

Purpose
Sets the message type.
Declaration
mqboolean MSG_setJMSType(Message msg, mqstring type);
Include
message.h
Parameters
msg
Message
type
The type of message
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

MSG_setLongProperty

Purpose
Sets an mqlong property value, into the Message, with the given name.
Declaration
mqboolean MSG_setLongProperty(Message msg, mqstring propName,mqlong propValue);
Include
message.h
Parameters
msg
Message
propName
Name of the mqlong property
propValue
mqlong property value to set in the message
Return Values
mqboolean

MSG_setObjectProperty

Purpose
Sets an Object as a property on a message.
Declaration
mqboolean MSG_setObjectProperty(Message msg, mqstring propName, mqobject propValue, mqint size);
Include
message.h
Parameters
msg
The message on which the property is to be set
propName
Name of the Property to be set
Parameters
propValue
The Object that is to be set as property
size
Size of the Object taken as an integer
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

MSG_setShortProperty

Purpose
Sets an mqshort property value, into the Message, with the given name.
Declaration
mqboolean MSG_setShortProperty(Message msg, mqstring propName, mqshort propValue);
message.h
Parameters
msg
Message
propName
Name of the mqshort property
propValue
mqshort property value to set in the message
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

MSG_setStringProperty

Purpose
Sets an mqstring property value, into the Message, with the given name.
Declaration
mqboolean MSG_setStringProperty(Message msg, mqstring propName, mqstring propValue);
Include
message.h
Parameters
msg
Message
propName
Name of the mqstring property
propValue
mqstring property value to set in the message
Return Values
mqboolean

newHashtable

Purpose
Constructs a new, empty hashtable with a default initial capacity (11) and load factor, which is 0.75.
Declaration
Hashtable newHashtable();
Include
fiorano_hashtable.h
Return Values
Hashtable
The empty hashtable structure

newInitialContext_env

Purpose
Constructs the Initial Context for lookup of Admin Objects using the hashtable passed as argument. This hashtable has all the required environment properties passed as name-value pairs.
Declaration
InitialContext newInitialContext_env(struct _Hashtable* env);
Include
initial_context.h
Parameters
env
The Hashtable structure containing environment parameters such as url, user-name, password
Return Values
InitialContext
A newly created InitialContext structure, NULL if an error occurs h1.newInitialContext_HTTP
Purpose
Constructs the Initial Context for lookup of Admin Objects, using the HTTP protocol for communication.
Declaration
InitialContext newInitialContext_HTTP(mqstring url, mqstring username, mqstring passwd);
Include
initial_context.h
Parameters
url
URL of the FioranoMQ Server
username
The user name to be used for lookup
passwd
The password for the username
Return Values
InitialContext
A newly created InitialContext structure, NULL if an error occurs

newInitialContext_SSL

Purpose
Constructs the Initial Context for lookup of Admin Objects using the SSL protocol. The various SSL parameters are passed as arguments to this API.
Declaration
InitialContext newInitialContext_SSL(mqstring url, mqstring user-name, mqstring passwd, mqstring certFile, mqstring privateKeyFile, mqstring keyPass);
Include
initial_context.h
url
URL of the FioranoMQ Server
username
The user name to be used for lookup
passwd
The password for the user
certFile
Fully qualified path of certificate file
privateKeyFile
Fully qualified path of private key file
keyPass
Password under which private key file is encrypted
Return Values
InitialContext
A newly created InitialContext structure, NULL if an error occurs

newInitialContext1

Purpose
Constructs the Initial Context for lookup of Admin Objects using the serverName, port, username and password passed as arguments.
Declaration
InitialContext newInitialContext1(mqstring serverName, mqint port, mqstring username, mqstring passwd);
Include
initial_context.h
Parameters
address
Name or IP Address of the machine on which FioranoMQ is running
port
Port number on which FioranoMQ Server is running
Username
The user name to be used for lookup
passwd
Password for the username
Return Values
InitialContext
A newly created InitialContext structure, NULL if an error occurs

newInitialContext

Purpose
Constructs the Initial Context for lookup of Admin Objects using the url, username and password that are passed as parameters.
Declaration
InitialContext newInitialContext(mqstring url, mqstring username, mqstring passwd);
Include
initial_context.h
Parameters
url
URL of FioranoMQ Server that includes the address and port
username
The user name that is used for lookup
passwd
Password for the username
Return Values
InitialContext
A newly created InitialContext structure, NULL if an error occurs h1.newInitialContextDefaultParams
Purpose
Creates the Initial Context for lookup of Admin Objects using the the default values for address, port number, username and password. The default values are as follows:
address = localhostport = 1856username = anonymouspassword = anonymous
Declaration
InitialContext newInitialContextDefaultParams();
Include
initial_context.h
Return Values
InitialContext
A newly created InitialContext structure, NULL if an error occurs

newQueueRequestor

Purpose
Creates a new QueueRequestor on the specified Queue. This implementation assumes the session parameter to be non-transacted, with a delivery mode of AUTO_ACKNOWLEDGE.
Declaration
QueueRequestor newQueueRequestor(QueueSession session, Queue queue);
Include
queue_requestor.h
Parameters
session
The queue session
queue
The queue on which the request/reply call is to be performed
Return Values
QueueRequestor
Newly created QueueRequestor

newTopicRequestor

Purpose
Creates a TopicRequestor.
This implementation assumes the session parameter to be non-transacted, with a delivery mode of AUTO_ACKNOWLEDGE.
Declaration
TopicRequestor newTopicRequestor(TopicSession session, Topic topic);
Include
topic_requestor.h
Parameters
session
The topic session to which the topic belongs
topic
The topic on which the request/reply call is to be performed
Return Values
TopicRequestor
Newly created TopicRequestor, NULL if an error occurs

Q_free

Purpose
Frees all the resources allocated on behalf of a queue structure.
Declaration
void Q_free(Queue queue);
Include
queue.h
Parameters
queue
The Queue structure that has to be freed

Q_getQueueName

Purpose
Gets name of the queue passed as argument.
Declaration
mqstring Q_getQueueName(Queue queue);
Include
queue.h
Parameters
queue
Queue whose name is desired
Return Values
mqstring
The queue name

QBE_free

Purpose
Frees all the resources allocated on behalf of QueueBrowserEnumeration.
Declaration
void QBE_free(QueueBrowserEnumeration browserEnum);
Include
queue_browser_enumeration.h
Parameters
browserEnum
QueueBrowserEnumeration that has to be cleaned up

QBE_hasMoreElements

Purpose
Checks if the queue browser enumeration contains more elements that is, messages.
Declaration
mqboolean QBE_hasMoreElements(QueueBrowserEnumeration browserE-num);
Include
queue_browser_enumeration.h
Parameters
browserEnum
QueueBrowserEnumeration that has to be checked for more elements
Return Values
mqboolean
TRUE if and only if QueueBrowserEnumeration contains atleast one element; false otherwise h1.QBE_nextElement
Purpose
Gets the next message available with the queue browser enumeration.
Declaration
Message QBE_nextElement(QueueBrowserEnumeration browserEnum);
Include
queue_browser_enumeration.h
Parameters
browserEnum
QueueBrowserEnumeration whose next message is desired
Return Values
Message
The next available message in the enumeration; NULL if an error occurs h1.QBWSR_close
Purpose
Closes all the resources on behalf of a QueueBrowser.
Declaration
mqboolean QBWSR_close(QueueBrowser browser);
Include
queue_browser.h
Parameters
browser
The QueueBrowser that has to be closed
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

QBWSR_free

Purpose
Frees the resources allocated for the QueueBrowser.
Declaration
void QBWSR_free(QueueBrowser browser);
Include
queue_browser.h
Parameters
browser
QueueBrowser that has to be cleaned up

QBWSR_getEnumeration

Purpose
Gets an enumeration for browsing the current queue messages in the same order as they would be received.
Declaration
struct _QueueBrowserEnumeration* QBWSR_getEnumeration(QueueBrowserbrowser);
Include
queue_browser.h
Parameters
browser
QueueBrowser using which the Enumeration is being obtained
Return Values
struct _QueueBrowserEnumeration*
QueueBrowserEnumeration for browsing the messages

QBWSR_getMessageSelector

Purpose
Gets message selector expression of this queue browser.
Declaration
mqstring QBWSR_getMessageSelector(QueueBrowser browser);
Include
queue_browser.h
Parameters
browser
QueueBrowser whose message selector is desired
Return Values
mqstring
The message selector of queue browser

QBWSR_getQueue

Purpose
Get the queue on which this queue browser is created.
Declaration
Queue QBWSR_getQueue(QueueBrowser browser);
Include
queue_browser.h
Parameters
browser
QueueBrowser whose Queue is desired
Return Values
Queue
The Queue over which the QueueBrowser is created

QC_close

Purpose
Closes the connection. There is no need to close the sessions, producers, and consumers of a closed connection.
Closing a connection causes all temporary destinations to be deleted.
Declaration
mqboolean FBMSG_readBoolean(BytesMessage msg, mqboolean* value);
Include
queue_connection.h
Parameters
connection
QueueConnection that has to be closed
Return Values
mqboolean

QC_createQueueSession

Purpose
Creates a QueueSession with the given mode.
Declaration
QueueSession QC_createQueueSession(QueueConnection connection, mqboolean transacted, mqint acknowledgeMode);
Include
queue_connection.h
Parameters
connection
QueueConnection
mqboolean
Indicates if the session is transacted. If TRUE, the session is transacted.
acknowledgeMode
Indicates whether the consumer or the client acknowledges any messages it receives; ignored if the session is transacted. Legal values AUTO_ACKNOWLEDGE, CLIENT_ACKNOWLEDGE and DUPS_OK_ACKNOWLEDGE.
Return Values
QueueSession
A newly created QueueSession, NULL if an error occurs
For values of the different acknowledgement modes, refer to the chapter "C-rtl Contants". h1.QC_free
Purpose
Frees all the resources allocated for the QueueConnection.
Declaration
void QC_free(QueueConnection connection);
Include
queue_connection.h
Parameters
connection
QueueConnection that has to be cleaned up

QC_getClientID

Purpose
Gets the client identifier for this connection. This value is specific to the JMS provider. It is either preconfigured by an administrator in a ConnectionFactory object or assigned dynamically by the application by calling the setClientID method.
Declaration
mqstring QC_getClientID(QueueConnection connection);
Include
queue_connection.h
Parameters
connection
The QueueConnection for which the clientID is desired
Return Values
mqstring
The unique client identifier for this connection

QC_getExceptionListener

Purpose
Returns the ExceptionListener structure for this Queue connection.
Declaration
ExceptionListener QC_getExceptionListener(QueueConnection connec-tion);
queue_connection.h
Parameters
connection
The QueueConnection for which the exception listener is desired
Return Values
ExceptionListener
The ExceptionListener for this connection
For details, refer to the chapter"ExceptionListener".

QC_setClientID

Purpose
Sets the client identifier for this connection. The preferred way to assign a client identifier of a JMS client is to configure it in a client-specific ConnectionFactory object, which is then transparently assigned to the Connection object it creates.
The purpose of the client identifier is to associate a connection and its objects with a state maintained on behalf of the client by a provider. The only such state identified by the JMS API is that required to support durable subscriptions.
If another connection with the same clientID is running, when this method is called, an error is returned.
Declaration
mqboolean QC_setClientID(QueueConnection connection, mqstring clientID);
Include
queue_connection.h
Parameters
connection
QueueConnection for which the clientID is to be set
clientID
The unique client identifier
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

QC_setExceptionListener

Purpose
Sets an exception listener for this connection. If the FioranoMQ server detects a serious problem with a connection, it notifies the ExceptionListener of the connection, if one has been registered. This is done by calling the onException method of the listener.
Declaration
mqboolean QC_setExceptionListener(QueueConnection connection, ExceptionListenerPointer ptrListener, void* param);
Include
queue_connection.h
Parameters
connection
QueueConnection for which the ExceptionListener is to be set
ptrListener
The function pointer of the callback function for the ExceptionListener to be registered
param
Any parameter that is required by the client application in the onException callback of the ExceptionListener
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs
For details, refer to the chapter "ExceptionListener".

QC_start

Purpose
Starts (or restarts) the delivery of incoming messages of a connection. A call to start on a connection that has already been started is ignored.
Declaration
mqboolean QC_start(QueueConnection connection);
Include
queue_connection.h
Parameters
connection
QueueConnection that has to be started
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

QC_stop

Purpose
Temporarily stops the delivery of incoming messages of a connection. Delivery can be restarted using the start method of a connection. When the connection is stopped, delivery to all the message consumers of the connection is inhibited: synchronous receives block, and messages are not delivered to message listeners.
This call blocks until receives and/or message listeners in progress have completed. Stopping a connection has no effect on its ability to send messages. A call to stop on a connection that has already been stopped is ignored.
Declaration
mqboolean QC_stop(QueueConnection connection);
Include
queue_connection.h
Parameters
connection
QueueConnection that has to be stopped
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

QCF_createQueueConnection

Purpose
Creates a queue connection with specified user identity. The connection is created in stopped mode. No messages are delivered until the QC_start method is explicitly called.
Declaration
QueueConnection QCF_createQueueConnection(QueueConnectionFactory qcf, mqstring userName, mqstring password);
Include
queue_connection_factory.h
Parameters
qcf
QueueConnectionFactory using which the QueueConnection is to be created
userName
User name to be used for creating the QueueConnection
password
Password for the specified user
Return Values
QueueConnection
A newly created QueueConnection, NULL if an error occurs

QCF_createQueueConnectionDefParams

Purpose
Creates a queue connection with default user identity. The connection is created in stopped mode. No messages are delivered until the QC_start method is explicitly called.
Declaration
QueueConnection QCF_createQueueConnectionDefParams(QueueConnectionFactory qcf);
queue_connection_factory.h
Parameters
qcf
QueueConnectionFactory using which the QueueConnection is to be created
Return Values
QueueConnection
A newly created QueueConnection, NULL if an error occurs

QCF_free

Purpose
Frees all the resources allocated for the QueueConnectionFactory.
Declaration
void QCF_free(QueueConnectionFactory qcf);
Include
queue_connection_factory.h
Parameters
qcf
QueueConnectionFactory that has to be freed

QRCVR_close

Purpose
Closes the queue receiver and the resources allocated on behalf of the QueueReceiver.
This call blocks until it receives the message, or message listener in progress has completed. A blocked queue receiver call returns null when this queue receiver is closed.
Declaration
mqboolean QRCVR_close(QueueReceiver receiver);
queue_connection_factory_metadata.h
Parameters
receiver
QueueReceiver that is to be closed
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

QRCVR_free

Purpose
Frees the resources assigned to a queue receiver.
Declaration
void QRCVR_free(QueueReceiver receiver);
Include
queue_connection_factory_metadata.h
Parameters
receiver
QueueReceiver that is to be freed

QRCVR_getMessageListener

Purpose
Gets the MessageListener of the queue receiver
Declaration
MessageListener QRCVR_getMessageListener(QueueReceiver receiver);
Include
queue_connection_factory_metadata.h
Parameters
receiver
Return Values
MessageListener
Listener for the message consumer, NULL if no listener is set
Also, refer to the section "QRCVR_setMessageListener"

QRCVR_getMessageSelector

Purpose
Gets the message selector expression of this queue receiver.
Declaration
mqstring QRCVR_getMessageSelector(QueueReceiver receiver);
Include
queue_connection_factory_metadata.h
Parameters
receiver
QueueReceiver whose message selector is desired
Return Values
mqstring
Message selector of this queue receiver as mqstring, NULL if no message selector is set or message selector is set as NULL

QRCVR_getQueue

Purpose
Gets the queue associated with this queue receiver.
Declaration
Queue QRCVR_getQueue(QueueReceiver receiver);
queue_connection_factory_metadata.h
Parameters
receiver
QueueReceiver whose queue is desired
Return Values
Queue
Queue of this receiver

QRCVR_receive

Purpose
Receives the next message produced for this queue receiver. This call blocks indefinitely until a message is produced or this queue receiver is closed.
If this receive is done within a transaction, the receiver retains the message until the transaction commits.
Declaration
Message QRCVR_receive(QueueReceiver receiver);
Include
queue_connection_factory_metadata.h
Parameters
receiver
QueueReceiver on which the receive has to be called
Return Values
Message
The next message produced for this queue receiver, NULL if this queue receiver is concurrently closed.

QRCVR_receiveNoWait

Purpose
Receives the next message if one is immediately available.
Declaration
Message QRCVR_receiveNoWait(QueueReceiver receiver);
Include
queue_receiver.h
Parameters
receiver
QueueReceiver on which the receive call is made
Return Values
Message
The next message produced for this message consumer, NULL if one is not available. h1.QRCVR_receiveWithTimeout
Purpose
Receives the next message that arrives within the specified timeout interval. This call blocks until a message arrives, the timeout expires, or this queue receiver is closed. A timeout of zero never expires, and the call blocks indefinitely.
Declaration
Message QRCVR_receiveWithTimeout(QueueReceiver receiver, mqlong time0out);
Include
queue_connection_factory_metadata.h
Parameters
receiver
QueueReceiver on which the receive call is made
timeout
The timeout value (in milliseconds)
Return Values
Message
The next message produced for this queue receiver, null if the timeout expires or this queue receiver is concurrently closed

QRCVR_setFioranoMessageListener

Purpose
Sets MessageListener of the message consumer. This API can be used to set a FioranoMessageListener callback pointer that can be passed a parameter, which in turn can be used in the implementation of the callback function.
Declaration
mqboolean QRCVR_setFioranoMessageListener(QueueReceiver consumer, FioranoMessageListener ptrmessageListener, void* param);
Include
queue_receiver.h
Parameters
consumer
QueueReceiver whose message listener is to be set
ptrmessageListener
Listener to which the messages are to be delivered. This listener accepts a Message structure and a void* parameter as its arguments.
param
Parameter to be used in the MessageListener callback
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

QRCVR_setMessageListener

Purpose
Sets MessageListener of the message consumer.
Declaration
mqboolean QRCVR_setMessageListener(QueueReceiver receiver, MessageListener listener);
Include
queue_receiver.h
Parameter
receiver
QueueReceiver whose message listener is to be set
messageListener
Listener to which the messages are to be delivered
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

QRQST_close

Purpose
Closes the queue requestor and all the resources allocated on behalf of the QueueRequestor.
Declaration
void QRQST_close(QueueRequestor requestor);
Include
queue_requestor.h
Parameters
requestor
QueueRequestor that has to be closed

QRQST_free

Purpose
Frees the resources allocated on behalf of the QueueRequestor.
Declaration
void QRQST_free(QueueRequestor requestor);
Include
queue_requestor.h
Parameters
requestor

QRQST_request

Purpose
Sends a request and waits for a reply. The temporary queue is used for the JMSReplyTo destination. Only one reply per request is expected.
Declaration
Message QRQST_request(QueueRequestor requestor, Message message);
Include
queue_requestor.h
Parameters
requestor
QueueRequestor on which the request has to be made
message
The message to be sent
Return Values
Message
The reply message, NULL if an error occurs

QRQST_requestWithTimeout

Purpose
Sends a request and waits for a reply within the specified timeout interval. The temporary queue is used for the JMSReplyTo destination, and only one reply per request is expected.
Declaration
Message QRQST_requestWithTimeout(QueueRequestor requestor, Message message, mqlong timeout);
Include
queue_requestor.h
Parameters
requestor
QueueRequestor on which the request is to be made
message
The message to be sent
timeout
The timeout period for which the requestor waits for a reply
Return Values
Message
The reply message, NULL if an error occurs

QS_close

Purpose
Closes the queue session and resources allocated on behalf of the QueueSession.
Declaration
mqboolean QS_close(QueueSession session);
Include
queue_session.h
Parameters
session
QueueSession that has to be closed
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

QS_commit

Purpose
Commits all messages done in this transaction and releases any locks held at the time of call of this API.
Declaration
mqboolean QS_commit(QueueSession session);
Include
queue_session.h
Parameters
session
QueueSession that has to be committed
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

QS_createBrowser

Purpose
Creates a QueueBrowser to peek at the messages on the specified queue.
Declaration
QueueBrowser QS_createBrowser(QueueSession session, Queue queue);
Include
queue_session.h
Parameters
session
QueueSession using which the browser is to be created
queue
The queue to be accessed
Return Values
QueueBrowser
Newly created QueueBrowser, NULL if an error occurs

QS_createBrowserWithSelector

Purpose
Creates a QueueBrowser to peek at the messages using a message selector on the specified queue.
Declaration
QueueBrowser QS_createBrowserWithSelector(QueueSession session, Queue queue, mqstring messageSelector);
Include
queue_session.h
Parameters
session
QueueSession using which the browser is to be created
queue
The queue to be accessed
messageSelector
Only messages with properties matching the message selector expression are delivered. A value of null or an empty string indicates that there is no message selector for the browser.
Return Values
QueueBrowser
Newly created QueueBrowser, NULL if an error occurs

QS_createBytesMessage

Purpose
Creates a bytes message. A BytesMessage is used to send a message containing a stream of uninterpreted bytes.
Declaration
Message QS_createBytesMessage(QueueSession session);
Include
queue_session.h
Parameters
session
QueueSession using which the bytes message is to be created.
Return Values
Message
A newly created BytesMessage, NULL if an error occurs

QS_createMapMessage

Purpose
Creates a map message. A MapMessage object is used to send a self-defining set of name-value pairs, where names are of type mqstring and values can be different datatypes.
Declaration
Message QS_createMapMessage(QueueSession session);
Include
queue_session.h
Parameters
session
QueueSession using which the map message is to be created
Return Values
Message
A newly created MapMessage, NULL if an error occurs

QS_createQueue

Purpose
Creates a queue identity given a Queue name.
Declaration
Queue QS_createQueue(QueueSession session, mqstring queueName);
queue_session.h
Parameters
session
QueueSession using which the queue is to be created
queueName
Name of this queue
Return Values
Queue
A Queue with the given name

QS_createReceiver

Purpose
Creates a QueueReceiver to receive messages from the specified queue.
Declaration
QueueReceiver QS_createReceiver(QueueSession session, Queue queue);
Include
queue_session.h
Parameters
session
QueueSession using which the receiver is to be created
queue
The queue to be accessed
Return Values
QueueReceiver
Newly created QueueReceiver, NULL if an error occurs

QS_createReceiverWithSelector

Purpose
Creates a QueueReceiver to receive messages from the specified queue, using a message selector.
Declaration
QueueReceiver QS_createReceiverWithSelector(QueueSession session,Queue queue, mqstring messageSelector);
Include
queue_session.h
Parameters
session
QueueSession using which the receiver is to be created
queue
The queue to be accessed
messageSelector
Only messages with properties matching the message
Return Values
QueueReceiver
Newly created QueueReceiver, NULL if an error occurs

QS_createSender

Purpose
Creates a QueueSender to send messages to the specified queue.
Declaration
QueueSender QS_createSender(QueueSession session, Queue queue);
Include
queue_session.h
Parameters
Session
QueueSession using which the sender is to be created
queue
The queue to be accessed, null if this is an unidentifed producer
Return Values
QueueSender
Newly created QueueSender, NULL if an error occurs

QS_createStreamMessage

Purpose
Creates a StreamMessage. A StreamMessage is used to send a self-defining stream of different datatypes.
Declaration
Message QS_createStreamMessage(QueueSession session);
Include
queue_session.h
Parameters
session
QueueSession using which the stream message is to be created
Return Values
Message
A newly created StreamMessage, NULL if an error occurs

QS_createTemporaryQueue

Purpose
Creates a temporary queue. Lifetime of the temporary queue is that of the QueueConnection, unless deleted earlier.
Declaration
TemporaryQueue QS_createTemporaryQueue(QueueSession session);
Include
queue_session.h
Parameters
session
QueueSession using which the temporary queue is to be created
Return Values
TemporaryQueue
A temporary queue identity

QS_createTextMessage

Purpose
Creates a text message. A TextMessage is used to send a message containing an mqstring.
Declaration
Message QS_createTextMessage(QueueSession session);
Include
queue_session.h
Parameters
session
QueueSession using which the text message is to be created
Return Values
Message
A newly created TextMessage, NULL if an error occurs

QS_createTextMessageWithText

Purpose
Creates an initialized text message. A TextMessage is used to send a message containing an mqstring.
Declaration
Message QS_createTextMessageWithText(QueueSession session, mqstring text);
queue_session.h
Parameters
session
QueueSession using which the text message is to be created
text
The string used to initialize this message
Return Values
Message
A newly created TextMessage, NULL if an error occurs

QS_free

Purpose
Frees all the resources allocated on behalf of the QueueSession.
Declaration
void QS_free(QueueSession session);
Include
queue_session.h
Parameters
session
QueueSession that has to be freed

QS_getMessageListener

Purpose
Returns the distinguished message listener of the session.
Declaration
MessageListener QS_getMessageListener(QueueSession session);
Include
queue_session.h
Parameters
session
QueueSession whose message listener is desired
Return Values
MessageListener
The message listener associated with this session
Also, refer to the section "QS_setMessageListener"

QS_getTransacted

Purpose
Indicates if the session is in transacted mode.
Declaration
mqboolean QS_getTransacted(QueueSession session);
Include
queue_session.h
Parameters
session
QueueSession that has to be checked
Return Values
mqboolean
TRUE if in transacted mode

QS_recover

Purpose
Stops message delivery in this session, and restarts message delivery with the oldest unacknowledged message.
Declaration
mqboolean QS_recover(QueueSession session);
queue_session.h
Parameters
session
QueueSession that has to be recovered
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

QS_rollback

Purpose
Rollbacks any messages done in this transaction and releases any locks held at the time of call of this API.
Declaration
mqboolean QS_rollback(QueueSession session);
Include
queue_session.h
Parameters
session
QueueSession that has to be rollbacked
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

QS_setFioranoMessageListener

Purpose
Sets the distinguished MessageListener of the session. This API can be used to set a FioranoMessageListener callback pointer that can be passed a parameter, which in turn can be used in the implementation of the callback function.
Declaration
mqboolean QS_setFioranoMessageListener(Queuesession session, FioranoMessageListener ptrmessageListener, void* param);
Include
queue_session.h
Parameters
session
QueueSession whose message listener is to be set
ptrmessageListener
Listener to which the messages are to be delivered. This listener accepts a Message structure and a void* parameter as its arguments.
param
Parameter to be used in the MessageListener callback
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

QS_setMessageListener

Purpose
Sets the distinguished message listener of the session.
Declaration
mqboolean QS_setMessageListener(QueueSession session, MessageListener listener);
Include
queue_session.h
Parameters
session
QueueSession on which the message listener is to be set
listener
The message listener to associate with this session
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

QSNDR_close

Purpose
Closes the queue sender and the resources allocated on behalf of the QueueSender.
Declaration
mqboolean QSNDR_close(QueueSender sender);
Include
queue_sender.h
Parameters
sender
QueueSender to be closed
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

QSNDR_free

Purpose
Frees the resources allocated on behalf of the queue sender
Declaration
void QSNDR_free(QueueSender sender);
Include
queue_sender.h
Parameters
sender
QueueSender that is to be freed

QSNDR_getDeliveryMode

Purpose
Gets the default delivery mode of the sender.
Declaration
mqint QSNDR_getDeliveryMode(QueueSender sender);
Include
queue_sender.h
Parameters
sender
QueueSender whose delivery mode is desired
Return Values
mqint
The message delivery mode for this queue sender
Also, refer to the section "QSNDR_setDeliveryMode"

QSNDR_getDisableMessageID

Purpose
Gets an indication of whether message IDs are disabled.
Declaration
mqboolean QSNDR_getDisableMessageID(QueueSender sender);
Include
queue_sender.h
Parameters
sender
QueueSender for which the messageID disable indication is to be checked.
mqboolean
An indication of whether message IDs are disabled

QSNDR_getDisableMessageTimestamp

Purpose
Gets an indication of whether message timestamps are disabled.
Declaration
mqboolean QSNDR_getDisableMessageTimestamp(QueueSender sender);
Include
queue_sender.h
Parameters
sender
QueueSender for which the message timestamp disable indication is to be checked
Return Values
mqboolean
An indication of whether message timestamps are disabled
Also, refer tothe section "QSNDR_setDisableMessageTimestamp"

QSNDR_getPriority

Purpose
Gets the default priority of the sender.
Declaration
mqint QSNDR_getPriority(QueueSender sender);
Include
queue_sender.h
Parameter
sender
QueueSender whose priority is desired
Return Values
mqint
The message priority for this queue sender
Also, refer to the section "QSNDR_setPriority"

QSNDR_getQueue

Purpose
Gets the queue associated with this queue sender.
Declaration
Queue QSNDR_getQueue(QueueSender sender);
Include
queue_sender.h
Parameters
sender
QueueSender whose queue is desired
Return Values
Queue
The queue for this sender

QSNDR_getTimeToLive

Purpose
Gets the default length of time in milliseconds from its dispatch time, for which a produced message should be retained by the message system.
Declaration
mqlong QSNDR_getTimeToLive(QueueSender sender);
Include
queue_sender.h
Parameters
sender
QueueSender whose default message time to live is desired
Return Values
mqlong
The message time to live in milliseconds; zero is unlimited
Also, refer tothe section "QSNDR_getTimeToLive"

QSNDR_send

Purpose
Sends a message to the queue on which the sender was created. Uses the default delivery mode, timeToLive and priority of the QueueSender.
Declaration
mqboolean QSNDR_send(QueueSender sender, Message messge);
Include
queue_sender.h
Parameters
sender
QueueSender that is used for sending the message
message
The message to be sent
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

QSNDR_send1

Purpose
Sends a message specifying delivery mode, priority and time to live to the queue.
Declaration
mqboolean QSNDR_send1(QueueSender sender, Message message, mqint deliveryMode, mqint priority, mqlong timeToLive);
Include
queue_sender.h
Parameters
sender
QueueSender that is used for sending the message
message
The message to be sent
deliveryMode
The delivery mode to be used
priority
The priority for this message
timeToLive
Time-to-live (in milliseconds) of the message
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

QSNDR_send2

Purpose
Sends a message to the specified queue. Uses the default delivery mode, timeTo-Live and priority of the QueueSender.
Declaration
mqboolean QSNDR_send2(QueueSender sender, Queue queue, Message message);
queue_sender.h
Parameters
sender
QueueSender that is used for sending the message
queue
The queue to send this message to
message
The message to be sent
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

QSNDR_send3

Purpose
Sends a message to the specified queue, also specifying the delivery mode, priority and time to live to the queue.
Declaration
mqboolean QSNDR_send3(QueueSender sender, Queue queue, Message message, mqint deliveryMode, mqint priority, mqlong timeToLive);
Include
queue_sender.h
Parameters
sender
QueueSender that is used for sending the message
queue
Queue on which this message is to be sent
message
The message to be sent
deliveryMode
The delivery mode to be used The priority for this message
timeToLive
Time-to-live (in milliseconds) of the message
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

QSNDR_setDeliveryMode

Purpose
Sets the delivery mode for the sender. By default, delivery mode is set to PERSISTENT.
Declaration
mqboolean QSNDR_setDeliveryMode(QueueSender sender, mqint deliveryMode);
Include
queue_sender.h
Parameters
sender
QueueSender whose delivery mode is to be set
deliveryMode
The message delivery mode for this queue sender; legal values are NON_PERSISTENT and PERSISTENT.
For details, refer to the section "CRTL Constants"
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs
Also, refer to the section "QSNDR_getPriority"

QSNDR_setDisableMessageID

Purpose
Sets whether message IDs are disabled.
Declaration
mqboolean QSNDR_setDisableMessageID(QueueSender sender, mqboolean value);
Include
queue_sender.h
Parameters
sender
QueueSender for whose messages the messageIDs are to be disabled
value
Indicates if message IDs are disabled
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs
Also, refer tothe section "QSNDR_getDisableMessageID" h1.QSNDR_setDisableMessageTimestamp
Purpose
Sets whether message timestamps are disabled.
Declaration
mqboolean QSNDR_setDisableMessageTimestamp(QueueSender sender, mqboolean value);
Include
queue_sender.h
Parameter
sender
QueueSender for whose messages the messageIDs are to be disabled
value
Indicates if message timestamps are disabled
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs
Also, refer to the section "QSNDR_getDisableMessageTimestamp"

QSNDR_setPriority

Purpose
Sets the default priority of the sender. The JMS API defines ten levels of priority value, with 0 as the lowest priority and 9 as the highest. Clients should consider priorities 0-4 as gradations of normal priority and priorities 5-9 as gradations of expedited priority. By default, priority is set to 4.
Declaration
mqboolean QSNDR_setPriority(QueueSender sender, mqint messagePriority);
Include
queue_sender.h
Parameters
sender
QueueSender for whose messages the priority is to be set
messagePriority
The message priority for this sender; value must be between 0 and 9
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

QSNDR_setTimeToLive

Purpose
Sets the default length of time in milliseconds from its dispatch time, for which a produced message should be retained by the message system.
By default, Time to live is set to zero.
Declaration
mqboolean QSNDR_setTimeToLive(QueueSender sender, mqlong timeToLive);
Include
queue_sender.h
Parameters
sender
QueueSender for whose messages the time to live is to be set
timeToLive
The message time to live in milliseconds; zero is unlimited
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

T_free

Purpose
Frees the memory allocated to the topic structure.
Declaration
void T_free(Topic topic);
Include
topic.h
Parameters
topic
The topic that has to be freed

T_getTopicName

Purpose
Returns the topic name as mqstring.
Declaration
mqstring T_getTopicName(Topic topic);
Include
topic.h
Parameters
topic
Topic whose name is desired
Return Value
mqstring
Name of the topic

TC_close

Purpose
Terminates the connection with Fiorano JMS server and closes the resources allocated on behalf of the TopicConnection.
Declaration
mqboolean TC_close(TopicConnection tc);
Include
topic_connection.h
Parameters
tc
TopicConnection that is to be closed
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

TC_createTopicSession

Purpose
Creates a TopicSession with the given mode.
Declaration
TopicSession TC_createTopicSession(TopicConnection tc, mqboolean transacted, mqint acknowledgeMode);
Include
topic_connection.h
Parameters
tc
TopicConnection
mqboolean
Transacted, if TRUE the session is transacted
acknowledgeMode
Indicates whether the consumer or the client acknowledges any messages it receives.
Return Values
TopicSession
A newly created TopicSession, NULL if an error occurs

TC_free

Purpose
Frees all the resources allocated for the TopicConnection
Declaration
void TC_free(TopicConnection tc);
Include
topic_connection.h
Parameters
tc

TC_getClientID

Purpose
Gets the client identifier for this connection.
Declaration
mqstring TC_getClientID(TopicConnection tc);
Include
topic_connection.h
Parameters
tc
TopicConnection whose clientId is desired
Return Values
mqstring
The unique client identifier

TC_getExceptionListener

Purpose
Gets the ExceptionListener object for this connection. Certain connections may not have an ExceptionListener associated with it.
Declaration
struct _ExceptionListener* TC_getExceptionListener(TopicConnection tc);
Include
topic_connection.h
Parameters
connection
TopicConnection whose exception listener is desired
Return Values
ExceptionListener
Also, refer to the section "TC_setExceptionListener"

TC_setClientID

Purpose
Sets the client identifier for this connection.
Declaration
mqboolean TC_setClientID(TopicConnection tc, mqstring clientID);
Include
topic_connection.h
Parameters
connection
TopicConnection
clientID
The unique client identifier
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

TC_setExceptionListener

Purpose
Sets an exception listener for this connection. If a JMS provider detects a serious aberration with a connection, it notifies the ExceptionListener of the connection, if one has been registered. It does this by calling the onException method of the listener, sending it the error stack describing the problem.
An exception listener allows a client to be asynchronously notified of a problem. Certain connections only consume messages, hence these connections do not have any other method to be notified of connection failure.
mqboolean TC_setExceptionListener(TopicConnection connection, ExceptionListener-Pointer ptrListener, void* param);
Include
topic_connection.h
Parameters
connection
TopicConnection for which the exception listener is to be registered
ptrListener
Function pointer for callback method of the exception listener
param
Any parameter that is to be used in the callback method
Return Values
mqboolean
TRUE if successful, false if an error occurs

TC_start

Purpose
Starts (or restarts) delivery of incoming messages of a connection. A call to start on a connection that has already been started is ignored.
Declaration
mqboolean TC_start(TopicConnection tc);
Include
topic_connection.h
Parameters
tc
TopicConnection that is to be started
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

TC_stop

Purpose
Temporarily stops delivery of incoming messages of a connection. Delivery can be restarted using the start method of a connection. When the connection is stopped, delivery to all the message consumers of the connection is inhibited: synchronous receives block, and messages are not delivered to message listeners.
Declaration
mqboolean TC_stop(TopicConnection tc);
Include
topic_connection.h
Parameters
tc
TopicConnection that is to be stopped
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

TCF_createTopicConnection

Purpose
Creates a queue connection with specified user identity.
Declaration
TopicConnection TCF_createTopicConnection(TopicConnectionFactory tcf, mqstring username, mqstring password);
Include
topic_connection_factory.h
Parameters
tcf
TopicConnectionFactory to be used to create the connection
username
The user name to be used to create the connection The password for the specified username
Return Values
TopicConnection
A newly created TopicConnection, NULL if an error occurs

TCF_createTopicConnectionDefParams

Purpose
Creates a queue connection with default user identity.
Declaration
TopicConnection TCF_createTopicConnectionDefParams(TopicConnectionFactory tcf);
Include
topic_connection_factory.h
Parameters
tcf
TopicConnectionFactory to be used to create the connection
Return Values
TopicConnection
A newly created TopicConnection, NULL if an error occurs

TCF_free

Purpose
Frees all the resources allocated for the TopicConnectionFactory.
Declaration
void TCF_free(TopicConnectionFactory tcf);
Include
topic_connection_factory.h
Parameters
tcf
TopicConnectionFactory that is to be freed

TMPQ_delete

Purpose
Deletes this temporary queue. If there are existing receivers still using it, an error occurs.
Declaration
mqboolean TMPQ_delete(TemporaryQueue tempQueue);
Include
temporary_queue.h
Parameters
tempQueue
The temporary queue to be deleted
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

TMPQ_free

Purpose
Frees all the resources allocated on behalf of a temporary queue.
Declaration
void TMPQ_free(TemporaryQueue tempQueue);
Include
temporary_queue.h
Parameters
tempQueue
TemporaryQueue to be freed

TMPT_delete

Purpose
Deletes this temporary topic. If there are existing publishers or subscribers still using it, an error occurs.
Declaration
mqboolean TMPT_delete(TemporaryTopic tempTopic);
Include
temporary_topic.h
Parameters
tempTopic
The temporary topic to be deleted
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

TMPT_free

Purpose
Frees all the resources allocated on behalf of the temporary topic.
Declaration
void TMPT_free(TemporaryTopic tempTopic);
Include
temporary_topic.h
Parameters
tempTopic
The TemporaryTopic to be freed

TP_close

Purpose
Closes the TopicPublisher and the resources allocated on behalf of the TopicPublisher.
Declaration
mqboolean TP_close(TopicPublisher tp);
Include
topic_publisher.h
Parameters
tp
TopicPublisher that is to be closed
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

TP_free

Purpose
Frees the resources allocated on behalf of the topic publisher.
Declaration
void TP_free(TopicPublisher pub);
Include
topic_publisher.h
Parameters
pub
TopicPublisher that is to be freed

TP_getDeliveryMode

Purpose
Gets the default delivery mode of the producer.
Declaration
mqint TP_getDeliveryMode(TopicPublisher tp);
Include
topic_publisher.h
Parameters
tp
TopicPublisher whose delivery mode is desired
Return Values
mqint
The message delivery mode for this message producer

TP_getDisableMessageID

Purpose
Gets an indication of whether message IDs are disabled.
Declaration
mqboolean TP_getDisableMessageID(TopicPublisher tp);
Include
topic_publisher.h
Parameters
tp
TopicPublisher for which the messageID disable indication has to be checked
Return Values
mqboolean
An indication of whether message IDs are disabled

TP_getDisableMessageTimestamp

Purpose
Gets an indication of whether message timestamps are disabled.
Declaration
mqboolean TP_getDisableMessageTimestamp(TopicPublisher tp);
Include
topic_publisher.h
Parameters
tp
TopicPublisher for which the message timestamp indication has to be checked
Return Values
mqboolean
An indication of whether message IDs are disabled

TP_getPriority

Purpose
Gets the default priority of the producer.
Declaration
mqint TP_getPriority(TopicPublisher tp);
Include
topic_publisher.h
Parameters
tp
TopicPublisher whose priority is desired
Return Values
mqint
The message priority for this message producer

TP_getTimeToLive

Purpose
Gets the default length of time in milliseconds, from its dispatch time, for which a produced message should be retained by the message system.
Declaration
mqlong TP_getTimeToLive(TopicPublisher tp);
Include
topic_publisher.h
Parameters
tp
TopicPublisher whose message time to live is desired
Return Values
mqlong
The message time to live in milliseconds; zero is unlimited

TP_getTopic

Purpose
Gets the topic associated with this publisher.
Declaration
Topic TP_getTopic(TopicPublisher pub);
Include
topic_publisher.h
Parameters
pub
TopicPublisher whose topic is desired
Return Values
Topic
Topic associated with the publisher

TP_publish

Purpose
Publishes a message to the topic on which the publisher is created. Uses the default delivery mode, timeToLive and priority of the topic.
Declaration
mqboolean TP_publish(TopicPublisher pub, Message message);
Include
topic_publisher.h
Parameters
pub
TopicPublisher that is to be used to publish the message
message
The message to be published
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

TP_publish1

Purpose
Publishes a message to the topic on which the publisher is created, specifying delivery mode, priority and time to live to the topic.
Declaration
mqboolean TP_publish1(TopicPublisher pub, Message message, mqint deliveryMode, mqint priority, mqlong timeToLive);
Include
topic_publisher.h
Parameters
pub
TopicPublisher to be used for publishing the message
message
deliveryMode
The delivery mode to use
priority
Priority for this message
timeToLive
Lifetime (in milliseconds) of the message
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

TP_publish2

Purpose
Publishes a message to a topic for an unidentified message producer. Uses the default delivery mode, timeToLive and priority of the topic.
Declaration
mqboolean TP_publish2(TopicPublisher pub, Topic topic, Message message);
Include
topic_publisher.h
Parameters
pub
TopicPublisher on which message is to be published
topic
The topic to publish this message to
message
The message to be published
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

TP_publish3

Purpose
Publishes a message to a topic for an unidentified message producer, specifying delivery mode, priority and time to live.
Declaration
mqboolean TP_publish3(TopicPublisher pub, Topic topic, Message message, mqint deliveryMode, mqint priority, mqlong timeToLive);
Include
topic_publisher.h
Parameters
pub
TopicPublisher on which the message is to be published
topic
The topic to publish this message to
message
The message to be published
deliveryMode
The delivery mode to use
priority
The priority for this message
timeToLive
The lifetime (in milliseconds) of the message
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

TP_setDeliveryMode

Purpose
Sets the default delivery mode of the producer.
Declaration
mqboolean TP_setDeliveryMode(TopicPublisher tp, mqint deliveryMode);
Include
topic_publisher.h
Parameters
tp
TopicPublisher for whose messages the delivery mode is to be set.
deliveryMode
The message delivery mode for this message producer; legal values are NON_PERSISTENT and PERSISTENT.
For more information, read the CRTL Constants section
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

TP_setDisableMessageID

Purpose
Sets whether message IDs are disabled for this Topic Publisher.
Declaration
mqboolean TP_setDisableMessageID(TopicPublisher tp, mqboolean value);
Include
topic_publisher.h
Parameters
tp
TopicPublisher for which the messageID is to be disabled
value
Indicates if message IDs are disabled
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

TP_setDisableMessageTimestamp

Purpose
Sets whether message timestamps are disabled.
Declaration
mqboolean TP_setDisableMessageTimestamp(TopicPublisher tp, mqboolean value);
Include
topic_publisher.h
Parameters
tp
TopicPublisher for which the message timestamp is to be disabled
value
Indicates if message timestamps are disabled
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

TP_setPriority

Purpose
Sets the default priority of the producer.
The JMS API defines ten levels of priority value, with 0 as the lowest priority and 9 as the highest. Clients should consider priorities 0-4 as gradations of normal priority and priorities 5-9 as gradations of expedited priority. Priority is set to 4 by default.
Declaration
mqboolean TP_setPriority(TopicPublisher tp, mqint msgPriority);
Include
topic_publisher.h
Parameters
tp
TopicPublisher for which the default priority is to be set
msgPriority
The message priority for this message producer; must be a value between 0 and 9
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

TP_setTimeToLive

Purpose
Sets the default length of time in milliseconds, from its dispatch time, for which a produced message should be retained by the message system.
By default, Time to live is set to zero.
Declaration
mqboolean TP_setTimeToLive(TopicPublisher tp, mqlong timeToLive);
Include
topic_publisher.h
Parameters
tp
TopicPublisher for which the time to live is to be set
timeToLive
The message time to live in milliseconds; zero is unlimited
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

TRQST_close

Purpose
Closes the topic requestor and all the resources allocated on behalf of TopicRequestor.
Declaration
mqboolean TRQST_close(TopicRequestor requestor);
Include
topic_requestor.h
Parameters
requestor
TopicRequestor that is to be closed
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

TRQST_free

Purpose
Frees the resources allocated on behalf of TopicRequestor.
Declaration
void TRQST_free(TopicRequestor requestor);
Include
topic_requestor.h
Parameters
requestor
TopicRequestor that is to be freed

TRQST_request

Purpose
Sends a request and waits for a reply. The temporary topic is used for the JMSReplyTo destination; the first reply is returned, and any following replies are discarded.
Declaration
Message TRQST_request(TopicRequestor requestor, Message message);
Include
topic_requestor.h
Parameters
requestor
TopicRequestor that is to be used for sending the requests
message
The request to send
Return Values
Message
The reply message, NULL if an error occurs

TRQST_requestWithTimeout

Purpose
Sends a request and waits for a reply within the specified timeout interval.The temporary topic is used for JMSReplyTo destination; the first reply is returned and any following replies are discarded.
Declaration
Message TRQST_requestWithTimeout(TopicRequestor requestor, Message message, mqlong timeout);
Include
topic_requestor.h
Parameters
requestor
TopicRequestor that is to be used for sending the requests message
The request to send
timeout
The time for which the requestor waits for a reply
Return Values
Message
The reply message, NULL if an error occurs

TS_close

Purpose
Closes the topic session and resources allocated on behalf of the TopicSession.
Declaration
mqboolean TS_close(TopicSession ts);
Include
topic_session.h
Parameters
ts
TopicSession to be closed
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

TS_commit

Purpose
Commits all messages done in this transaction and releases any locks held at the time of call of this API.
Declaration
mqboolean TS_commit(TopicSession ts);
Include
topic_session.h
Parameters
ts
TopicSession to be committed
Return Values
TRUE if successful, FALSE if an error occurs

TS_createBytesMessage

Purpose
Creates a bytes message. A BytesMessage is used to send a message containing a stream of uninterpreted bytes.
Declaration
Message TS_createBytesMessage(TopicSession ts);
Include
topic_session.h
Parameters
ts
TopicSession using which the bytes message is to be created
Return Values
Message
Newly created BytesMessage, NULL if an error occurs

TS_createDurableSubscriber

Purpose
Creates a durable Subscriber to the specified topic.
If a client needs to receive all the messages published on a topic, including the ones published while the subscriber is inactive, it uses a durable TopicSubscriber. The FioranoMQ server retains a record of this durable subscription and insures that all messages from the publishers of the topic are retained, until they are acknowledged by this durable subscriber or have expired.
Sessions with durable subscribers must always provide the same client identifier. In addition, each client must specify a name that uniquely identifies (within client identifier) each durable subscription it creates. Only one session at a time can have a TopicSubscriber for a particular durable subscription.
A client can change an existing durable subscription by creating a durable Topic-Subscriber with the same name and a new topic and/or message selector. Changing a durable subscriber is equivalent to unsubscribing (deleting) the old one and creating a new one.
Declaration
TopicSubscriber TS_createDurableSubscriber(TopicSession ts, Topic topic, mqstring name);
Include
topic_session.h
Parameters
ts
TopicSession using which the durable subscriber is to be created
topic
The non-temporary topic to subscribe to
name
The name used to identify this subscription
Return Values
TopicSubscriber
Newly created TopicSubscriber, NULL if an error occurs

TS_createDurableSubscriberWithSelector

Purpose
Creates a Durable Subscriber to the given Topic with given message selector and local message delivery options.
If a client needs to receive all the messages published on a topic, including the ones published while the subscriber is inactive, it uses a durable TopicSubscriber. The FioranoMQ server retains a record of this durable subscription and insures that all messages from the publishers of the topic are retained until they are acknowledged by this durable subscriber or they have expired.
Sessions with durable subscribers must always provide the same client identifier. In addition, each client must specify a name that uniquely identifies (within client identifier) each durable subscription it creates. Only one session at a time can have a TopicSubscriber for a particular durable subscription.
A client can change an existing durable subscription by creating a durable Topic-Subscriber with the same name and a new topic and/or message selector. Changing a durable subscriber is equivalent to unsubscribing (deleting) the old one and creating a new one.
In certain instances, a connection may both publish and subscribe to a topic. The subscriber NoLocal attribute allows a subscriber to inhibit the delivery of messages published by its own connection. The default value for this attribute is false.
Declaration
TopicSubscriber TS_createDurableSubscriberWithSelector(TopicSession ts, Topic topic, mqstring subscriberID, mqstring messageselector, mqboolean nolocal);
Include
topic_session.h
Parameters
ts
TopicSession using which the durable subscriber is to be created
topic
The non-temporary topic to subscribe to
subscriberID
The name used to identify this subscription
messageselector
Only messages with properties matching the message selector expression are delivered
nolocal
If set, inhibits the delivery of messages published on the same connection
Return Values
TopicSubscriber
Newly created TopicSubscriber, NULL if an error occurs

TS_createMapMessage

Purpose
Creates a map message. A MapMessage object is used to send a self-defining set of name-value pairs, where names are of type mqstring and values can be of different datatypes.
Declaration
Message TS_createMapMessage(TopicSession ts);
Include
topic_session.h
Parameters
ts
TopicSession using which the map message is to be created
Return Values
Message
Newly created MapMessage, NULL if an error occurs

TS_createPublisher

Purpose
Creates a Publisher for the specified topic.
A client uses a TopicPublisher to publish messages on a topic. Each time a client creates a TopicPublisher on a topic, it defines a new sequence of messages that have no ordering relationship with the messages it has previously sent.
Declaration
TopicPublisher TS_createPublisher(TopicSession ts, Topic topic);
Include
topic_session.h
Parameters
ts
TopicSession using which the publisher is to be created
topic
The topic to publish to, null if this is an unidentifed producer
Return Values
TopicPublisher
Newly created TopicPublisher, NULL if an error occurs

TS_createPublisherOnTempTopic

Purpose
Creates a Publisher for the specified temporary topic.
Declaration
TopicPublisher TS_createPublisherOnTempTopic(TopicSession ts, TemporaryTopic temptopic);
Include
topic_session.h
Parameters
ts
TopicSession using which the publisher is to be created
temptopic
The topic to publish to, null if this is an unidentifed producer
Return Values
TopicPublisher
Newly created TopicPublisher, NULL if an error occurs

TS_createStreamMessage

Purpose
Creates a StreamMessage. A StreamMessage is used to send a self-defining stream of different datatypes.
Declaration
Message TS_createStreamMessage(TopicSession ts);
Include
topic_session.h
Parameters
ts
TopicSession using which the stream message is to be created
Message
Newly created StreamMessage, NULL if an error occurs

TS_createSubOnTempTopicWS

Purpose
Creates a non-durable Subscriber to the specified temporary topic using the specified message selector.
Declaration
TopicSubscriber TS_createSubOnTempTopicWS(TopicSession ts, TemporaryTopic temptopic, mqstring messageSelector, mqboolean nolocal);
Include
topic_session.h
Parameters
ts
TopicSession using which the subscriber is to be created
temptopic
The temporarytopic to subscribe to
messageselector
Only messages with properties matching the message selector expression are delivered
nolocal
If set, inhibits the delivery of messages published on the same connection
Return Values
TopicSubscriber
Newly created TopicSubscriber, NULL if an error occurs

TS_createSubscriber

Purpose
Creates a non-durable Subscriber to the specified topic. A client uses a TopicSubscriber to receive messages that have been published to a topic.
Declaration
TopicSubscriber TS_createSubscriber(TopicSession ts, Topic topic);
Include
topic_session.h
Parameters
ts
TopicSession using which the subscriber is to be created
topic
The topic to subscribe to
Return Values
TopicSubscriber
Newly created TopicSubscriber, NULL if an error occurs

TS_createSubscriberOnTempTopic

Purpose
Creates a non-durable Subscriber to the specified temporary topic.
Declaration
TopicSubscriber TS_createSubscriberOnTempTopic(TopicSession ts, TemporaryTopic temptopic);
Include
topic_session.h
Parameters
ts
TopicSession using which the subscriber is to be created
temptopic
The temporary topic to subscribe to
Return Values
TopicSubscriber

TS_createSubscriberWithSelector

Purpose
Creates a non-durable Subscriber to the specified topic using the specified message selector.
A client uses a TopicSubscriber to receive messages that have been published to a topic. Regular TopicSubscribers are not durable. They receive only messages that are published while they are active.
Messages filtered out by the message selector of a subscriber would never be delivered to the subscriber. From the perspective of a subscriber, they do not exist.
In certain instances, a connection may both publish and subscribe to a topic. The subscriber NoLocal attribute allows a subscriber to inhibit the delivery of messages published by its own connection. The default value for this attribute is false.
Declaration
TopicSubscriber TS_createSubscriberWithSelector(TopicSession ts, Topic topic, mqstring messageSelector, mqboolean nolocal);
Include
topic_session.h
Parameters
ts
TopicSession using which the subscriber is to be created
topic
The topic to subscribe to
messageselector
Only messages with properties matching the message selector
nolocal
If set, inhibits the delivery of messages published on the same connection
Return Values
TopicSubscriber
Newly created TopicSubscriber, NULL if an error occurs

TS_createTemporaryTopic

Purpose
Creates a temporary topic. Lifetime of the topic is that of the TopicConnection, unless deleted earlier.
Declaration
TemporaryTopic TS_createTemporaryTopic(TopicSession ts);
Include
topic_session.h
Parameters
ts
TopicSession using which the temporary topic is to be created
Return Values
TemporaryTopic
A temporary topic identity; NULL if an error occurs

TS_createTextMessage

Purpose
Creates a text message. A TextMessage is used to send a message containing an mqstring.
Declaration
Message TS_createTextMessage(TopicSession ts);
Include
topic_session.h
Parameters
ts
TopicSession using which the text message is to be created
Return Values
Message
Newly created TextMessage, NULL if an error occurs

TS_createTextMessageWithText

Purpose
Creates an initialized text message. A TextMessage is used to send a message containing an mqstring.
Declaration
Message TS_createTextMessageWithText(TopicSession ts, mqstring text);
Include
topic_session.h
Parameters
ts
TopicSession using which the text message is to be created
text
The string used to initialize this message
Return Values
Message
Newly created TextMessage, NULL if an error occurs

TS_createTopic

Purpose
Creates a topic identity given a topic name.
Declaration
Topic TS_createTopic(TopicSession ts, mqstring topicname);
Include
topic_session.h
Parameters
ts
TopicSession using which the topic is to be created
topicname
Return Values
Topic
A Topic with the given name; NULL if an error occurs

TS_free

Purpose
Frees all the resources allocated on behalf of the TopicSession.
Declaration
void TS_free(TopicSession ts);
Include
topic_session.h
Parameters
ts
TopicSession to be freed

TS_getMessageListener

Purpose
Returns the distinguished message listener of the session.
Declaration
MessageListener TS_getMessageListener(TopicSession ts);
Include
topic_session.h
Parameters
ts
TopicSession whose message listener is desired
Return Values
MessageListener

TS_getTransacted

Purpose
Gets an indication whether the session is transacted.
Declaration
mqboolean TS_getTransacted(TopicSession ts, mqboolean *trans);
Include
topic_session.h
Parameters
ts
TopicSession that is to be checked
trans
Pointer to the boolean in which the return value is to be set
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

TS_recover

Purpose
Stops message delivery in this session, and restarts sending messages with the oldest unacknowledged message.
Declaration
mqboolean TS_recover(TopicSession ts);
Include
topic_session.h
Parameters
ts
TopicSession that is to be recovered
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

TS_rollback

Purpose
Rollbacks any messages done in this transaction and releases any locks held at the time of call of this API.
Declaration
mqboolean TS_rollback(TopicSession ts);
Include
topic_session.h
Parameters
ts
TopicSession to be rollbacked
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

TS_setFioranoMessageListener

Purpose
Sets the distinguished MessageListener of the session. This API can be used to set a FioranoMessageListener callback pointer that can be passed a parameter, which in turn can be used in the implementation of the callback function.
Declaration
mqboolean TS_setFioranoMessageListener(TopicSession session, FioranoMessageListener ptrmessageListener, void* param);
Include
topic_session.h
Parameters
session
TopicSession whose message listener is to be set
ptrmessageListener
Listener to which the messages are to be delivered. This listener accepts a Message structure and a void* parameter as its arguments.
param
Parameter to be used in the MessageListener callback
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

TS_setMessageListener

Purpose
Sets the distinguished message listener of the session.
Declaration
mqboolean TS_setMessageListener(TopicSession ts, MessageListener listener);
Include
topic_session.h
Parameters
ts
TopicSession whose message listener is to be set
listener
Message listener to associate with this session
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

TS_unsubscribe

Purpose
Unsubscribes a durable subscription that has been created by a client.
This method deletes the state being maintained on behalf of the subscriber by the FioranoMQ server.
It is erroneous for a client to delete a durable subscription while there is an active TopicSubscriber for the subscription, while a consumed message is part of a pending transaction, or has not been acknowledged in the session.
Declaration
mqboolean TS_unsubscribe(TopicSession ts, mqstring name);
Include
topic_session.h
Parameters
ts
TopicSession using which the subscription is to be unsubscribed
name
The name used to identify this subscription
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

TSUB_close

Purpose
Closes the TopicSubscriber and the resources allocated on behalf of TopicSubscriber.
Declaration
mqboolean TSUB_close(TopicSubscriber consumer);
Include
topic_subscriber.h
consumer
TopicSubscriber that is to be closed
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

TSUB_free

Purpose
Frees the resources allocated on behalf of TopicSubscriber.
Declaration
void TSUB_free(TopicSubscriber consumer);
Include
topic_subscriber.h
Parameters
consumer
TopicSubscriber that is to be freed

TSUB_getMessageListener

Purpose
Gets the MessageListener of this message consumer.
Declaration
MessageListener TSUB_getMessageListener(TopicSubscriber consumer);
Include
topic_subscriber.h
Parameters
consumer
TopicSubscriber whose message listener is desired
MessageListener
Listener for the message consumer, NULL if there is none set

TSUB_getMessageSelector

Purpose
Gets the message selector expression of this message consumer.
Declaration
mqstring TSUB_getMessageSelector(TopicSubscriber consumer);
Include
topic_subscriber.h
Parameters
consumer
TopicSubscriber whose message selector is desired
Return Values
mqstring
Message selector of this message consumer

TSUB_getNoLocal

Purpose
Gets the NoLocal attribute for this TopicSubscriber. The default value for this attribute is false.
Declaration
mqboolean TSUB_getNoLocal(TopicSubscriber consumer);
Include
topic_subscriber.h
Parameters
consumer
TopicSubscriber whose noLocal attribute is desired
mqboolean
TRUE if locally published messages are being inhibited

TSUB_getTopic

Purpose
Gets the topic associated with this subscriber.
Declaration
Topic TSUB_getTopic(TopicSubscriber consumer);
Include
topic_subscriber.h
Parameters
consumer
TopicSubscriber whose topic is desired
Return Values
Topic
Topic associated with this subscriber, NULL if an error occurs

TSUB_receive

Purpose
Receives the next message produced for this topic subscriber. This call blocks indefinitely until a message is produced or this topic subscriber is closed.
If this receive is done within a transaction, the subscriber retains the message until the transaction commits.
Declaration
Message TSUB_receive(TopicSubscriber consumer);
Include
topic_subscriber.h
consumer
TopicSubscriber on which receive is to be called
Return Values
Message
The next message produced for this message consumer, NULL if this topic subscriber is concurrently closed.

TSUB_receiveNoWait

Purpose
Receives the next message if one is immediately available.
Declaration
Message TSUB_receiveNoWait(TopicSubscriber consumer);
Include
topic_subscriber.h
Parameters
consumer
TopicSubscriber on which receive is called
Return Values
Message
The next message produced for this message consumer, null if one is not available. h1.TSUB_receiveWithTimeout
Purpose
Receives the next message that arrives within the specified timeout interval. This call blocks until a message arrives, the timeout expires, or this topic subscriber is closed. A timeout of zero never expires, and the call blocks indefinitely.
Declaration
Message TSUB_receiveWithTimeout(TopicSubscriber consumer, mqlong timeout);
topic_subscriber.h
Parameters
consumer
TopicSubscriber on which receive is called.
timeout
The timeout value (in milliseconds)
Return Values
Message
The next message produced for this message consumer, else NULL is returned h1.TSUB_setFioranoMessageListener
Purpose
Sets MessageListener of the message consumer. This API can be used to set a FioranoMessageListener callback pointer that can be passed a parameter, which in turn can be used in the implementation of the callback function.
Declaration
mqboolean TSUB_setFioranoMessageListener(TopicSubscriber consumer, FioranoMessageListener ptrmessageListener, void* param);
Include
topic_subscriber.h
Parameters
consumer
TopicSubscriber whose message listener is to be set
ptrmessageListener
Listener to which the messages are to be delivered. This listener accepts a Message structure and a void* parameter as its arguments.
param
Parameter to be used in the MessageListener callback
Return Values
mqboolean

TSUB_setMessageListener

Purpose
Sets the MessageListener of the message consumer.
Declaration
mqboolean TSUB_setMessageListener(TopicSubscriber consumer, MessageListener listener);
Include
topic_subscriber.h
Parameters
consumer
TopicSubscriber whose message listener is to be set
listener
The messages are delivered to this listener
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

UCF_createConnectionWithParams

Purpose
Creates a Unified connection with the connection factory based on the lazy thread creation flag
Declaration
FioranoConnection UCF_createConnectionWithParams (ConnectionFactory cf, mqstring userName, mqstring passWord)
Include
unified_connection_factory.h
Parameters
cf
ConnectionFactory to be used to create the connection.
userName
The user name to be used to create the connection
passWord
The password for the specified username
Return Value
FioranoConnection
A newly created FioranoConnection, NULL if an error occurs

UCF_createConnection

Purpose
Gets a Connection object from the connection factory.
Declaration
FioranoConnection UCF_createConnectionWithParams (ConnectionFactory cf)
Include
unified_connection_factory.h
Parameters
cf
ConnectionFactory to be used to create the connection.
Return Value
FioranoConnection
A newly created FioranoConnection, NULL if an error occurs

CF_free

Purpose
Frees Connection Factory Object.
Declaration
void CF_free(ConnectionFactory cf)
Include
unified_connection_factory.h
Parameters
cf
ConnectionFactory to be freed.

FC_createSession

Purpose
Creates a FioranoSession with the given mode.
Declaration
FioranoSession FC_createSession(FioranoConnection conn, mqboolean trasacted, mqint ackMode)
Include
fiorano_connection.h
Parameters
conn
FioranoConnection
transacted
Transacted, if TRUE the session is transacted
ackMode
Indicates whether the consumer or the client acknowledges any messages it receives.
Return Values
FioranoSession
A newly created FioranoSession, NULL if an error occurs

FC_getClientID

Purpose
Gets the client identifier for this connection.
Declaration
mqstring FC_getClientID(FioranoConnection conn)
Include
fiorano_connection.h
Parameters
conn
FioranoConnection whose clientId is desired
Return Values
mqstring
The unique client identifier

FC_getExceptionListener

Purpose
Gets the ExceptionListener object for this connection. Certain connections may not have an ExceptionListener associated with it.
Declaration
ExceptionListener FC_getExceptionListener(FioranoConnection conn)
Include
fiorano_connection.h
Parameters
conn
FioranoConnection whose exception listener is desired
Return Values
ExceptionListener
Also, refer to the section "FC_setExceptionListener"

FC_setClientID

Purpose
Sets the client identifier for this connection.
Declaration
void FC_setClientID(FioranoConnection conn, mqstring clientID)
Include
fiorano_connection.h
Parameters
conn
FioranoConnection
clientID
The unique client identifier
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

FC_setExceptionListener

Purpose
Sets an exception listener for this connection. If a JMS provider detects a serious aberration with a connection, it notifies the ExceptionListener of the connection, if one has been registered. It does this by calling the onException method of the listener, sending it the error stack describing the problem.
An exception listener allows a client to be asynchronously notified of a problem. Certain connections only consume messages, hence these connections do not have any other method to be notified of connection failure.
Declaration
void FC_setExceptionListener(FioranoConnection conn, ExceptionListener listener);
Include
fiorano_connection.h
Parameters
conn
FioranoConnection for which the exception listener is to be registered
listener
Function pointer for callback method of the exception listener
Return Values
mqboolean
TRUE if successful, false if an error occurs

FC_start

Purpose
Starts (or restarts) delivery of incoming messages of a connection. A call to start on a connection that has already been started is ignored.
Declaration
FC_start(FioranoConnection fc)
Include
fiorano_connection.h
Parameters
fc
FioranoConnection that is to be started
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

FC_stop

Purpose
Temporarily stops delivery of incoming messages of a connection. Delivery can be restarted using the start method of a connection. When the connection is stopped, delivery to all the message consumers of the connection is inhibited: synchronous receives block, and messages are not delivered to message listeners.
Declaration
Void FC_stop(FioranoConnection fc)
Include
fiorano_connection.h
Parameters
fc
FioranoConnection that is to be stopped
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

FC_free

Purpose
Frees all the resources allocated for the FioranoConnection
Declaration
void FC_free(FioranoConnection fc)
Include
fiorano_connection.h
Parameters
fc
FioranoConnection to be freed

FC_setUnifiedConnectionID

Purpose
Sets the client identifier for this unified connection.
Declaration
void FC_setUnifiedConnectionID(FioranoConnection fc, mqstring ucId)
Include
fiorano_connection.h
Parameters
fc
FioranoConnection
ucId
The unique client identifier for the unified connection
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

FC_getUnifiedConnectionID

Purpose
Gets the client identifier for this unified connection.
Declaration
mqstring FC_getUnifiedConnectionID(FioranoConnection fc)
Include
fiorano_connection.h
Parameters
fc
FioranoConnection whose clientId is desired
Return Values
mqstring
The unique client identifier for the unified Connection

US_getMessageListener

Purpose
Gets the message listener of the session.
Declaration
MessageListener US_getMessageListener(FioranoSession session)
Include
unified_session.h
Parameters
session
FioranoSession for which MessageListener to be returned.
Return Value
MessageListener
A MessageListener Object for the session

US_getTransacted

Purpose
Returns the Boolean whether the session is transacted.
Declaration
mqboolean US_getTransacted(FioranoSession session)
Include
unified_session.h
Parameters
session
FioranoSession that is to be checked.
Return Value
mqboolean
TRUE if session is transacted, FALSE if it is not.

US_ get AcknowledgeMode

Purpose
Returns the mode of Acknowledgement.
Declaration
mqint US_getAcknowledgeMode (FioranoSession session)
Include
unified_session.h
Parameters
session
FioranoSession for which Acknowledgement mode is to be returned.
Return Value
mqint
1 if acknowledge mode is AUTO_ACKNOWLEDGE, 2 if CLIENT_ACKNOWLEDGE, 3 if DUPS_OK_ACKNOWLEDGE

US_setMessageListener

Purpose
Sets a MessageListener to the Session.
Declaration
mqboolean US_setMessageListener (FioranoSession session, MessageListener listener)
Include
unified_session.h
Parameters
session
FioranoSession for which MessageListener is to be set.
listener
Message listener to associate with this session
Return Value
mqboolean
TRUE if successful, FALSE if an error occurs.

US_setFioranoMessageListener

Purpose
Sets a MessageListener to the Session.
Declaration
mqboolean US_setFioranoMessageListener (FioranoSession session, MessageListener listener, void* param)
Include
unified_session.h
Parameters
session
FioranoSession for which MessageListener is to be set.
listener
Listener to which the messages are to be delivered. This listener accepts a Message structure and a void* parameter as its arguments.
param
Parameter to be used in the MessageListener callback
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

US_createBrowser

Purpose
Creates a QueueBrowser to peek at the messages on the specified queue.
Declaration
QueueBrowser US_createBrowser(FioranoSession session, Queue queue);
Include
unified_session.h
Parameters
session
FioranoSession using which the browser is to be created
queue
The queue to be accessed
Return Values
QueueBrowser
Newly created QueueBrowser, NULL if an error occurs

US_createBrowserWithSelector

Purpose
Creates a QueueBrowser to peek at the messages using a message selector on the specified queue.
Declaration
QueueBrowser US_createBrowserWithSelector(FioranoSession session, Queue queue, mqstring messageSelector);
Include
unified_session.h
Parameters
session
FioranoSession using which the browser is to be created
queue
The queue to be accessed
messageSelector
Only messages with properties matching the message selector expression are delivered. A value of null or an empty string indicates that there is no message selector for the browser.
Return Values
QueueBrowser
Newly created QueueBrowser, NULL if an error occurs

US_createConsumer

Purpose
Creates a FioranoMessageConsumer to receive messages from the specified destination.
Declaration
FioranoMessageConsumer US_createConsumer(FioranoSession session, Destination destination)
Include
unified_session.h
Parameters
session
FioranoSession using which the Consumer is to be created
destination
The destination to be accessed
Return Values
FioranoMessageConsumer
Newly created FioranoMessageConsumer, NULL if an error occurs

US_createConsumerWithSelector

Purpose
Creates a FioranoMessageConsumer to receive messages from the specified destination, using a message selector.
Declaration
FioranoMessageConsumer US_createConsumerWithSelector(FioranoSession session, Destination destination, mqstring messageSelector, mqboolean nolocal);
Include
unified_session.h
Parameters
session
FioranoSession using which the receiver is to be created
destination
The destination to be accessed
messageSelector
Only messages with properties matching the message
nolocal
if set, inhibits the delivery of messages published by its own connection
Return Values
FioranoMessageConsumer
Newly created FioranoMessageConsumer, NULL if an error occurs

US_createProducer

Purpose
Creates a FioranoMessageProducer to send messages to the specified destination.
Declaration
FioranoMessageProducer US_createProducer(FioranoSession session, Destination destination);
Include
unified_session.h
Parameters
session
FioranoSession using which the producer is to be created
destination
The destination to be accessed, null if this is an unidentifed producer
Return Values
FioranoMessageProducer
Newly created FioranoMessageProducer, NULL if an error occurs

US_createDurableSubscriber

Purpose
Creates a durable Subscriber to the specified topic.
Declaration
TopicSubscriber US_createDurableSubscriber(FioranoSession session, Topic topic, mqstring name);
Include
unified_session.h
Parameters
session
FioranoSession using which the durable subscriber is to be created
topic
The non-temporary topic to subscribe to
name
The name used to identify this subscription
Return Values
TopicSubscriber
Newly created TopicSubscriber, NULL if an error occurs

US_createDurableSubscriberWithSelector

Purpose
Creates a Durable Subscriber to the given Topic with given message selector and local message delivery options.
Declaration
TopicSubscriber US_createDurableSubscriberWithSelector(FioranoSession session, Topic topic, mqstring subscriberID, mqstring messageselector, mqboolean nolocal);
Include
unified_session.h
Parameters
session
FioranoSession using which the durable subscriber is to be created
topic
The non-temporary topic to subscribe to
subscriberID
The name used to identify this subscription
messageselector
Only messages with properties matching the message selector expression are delivered
nolocal
If set, inhibits the delivery of messages published on the same connection
Return Values
TopicSubscriber
Newly created TopicSubscriber, NULL if an error occurs

US_createBytesMessage

Purpose
Creates a bytes message. A BytesMessage is used to send a message containing a stream of uninterpreted bytes.
Declaration
Message US_createBytesMessage(FioranoSession session);
Include
unified_session.h
Parameters
session
FioranoSession using which the bytes message is to be created
Return Values
Message
Newly created BytesMessage, NULL if an error occurs

US_createMapMessage

Purpose
Creates a map message. A MapMessage object is used to send a self-defining set of name-value pairs, where names are of type mqstring and values can be of different datatypes.
Declaration
Message US_createMapMessage(FioranoSession session);
Include
unified_session.h
Parameters
session
FioranoSession using which the map message is to be created
Return Values
Message
Newly created MapMessage, NULL if an error occurs

US_createStreamMessage

Purpose
Creates a StreamMessage. A StreamMessage is used to send a self-defining stream of different datatypes.
Declaration
Message US_createStreamMessage(FioranoSession session);
Include
unified_session.h
Parameters
session
FioranoSession using which the stream message is to be created
Return Values
Message
Newly created StreamMessage, NULL if an error occurs

US_createTextMessage

Purpose
Creates a text message. A TextMessage is used to send a message containing an mqstring.
Declaration
Message US_createTextMessage(FioranoSession session);
Include
unified_session.h
Parameters
session
FioranoSession using which the text message is to be created
Return Values
Message
Newly created TextMessage, NULL if an error occurs

US_createTextMessageWithText

Purpose
Creates an initialized text message. A TextMessage is used to send a message containing an mqstring.
Declaration
Message US_createTextMessageWithText(FioranoSession session, mqstring text);
Include
unified_session.h
Parameters
session
FioranoSession using which the text message is to be created
text
The string used to initialize this message
Return Values
Message
Newly created TextMessage, NULL if an error occurs

US_commit

Purpose
Commits all messages done in this transaction and releases any locks held at the time of call of this API.
Declaration
mqboolean US_commit(FioranoSession session);
Include
unified_session.h
Parameters
session
FioranoSession to be committed
Return Values
TRUE if successful, FALSE if an error occurs

US_recover

Purpose
Stops message delivery in this session, and restarts sending messages with the oldest unacknowledged message.
Declaration
mqboolean US_rollback(FioranoSession session);
Include
unified_session.h
Parameters
session
FioranoSession that is to be recovered
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

US_rollback

Purpose
Rollbacks any messages done in this transaction and releases any locks held at the time of call of this API.
Declaration
mqboolean US_recover(FioranoSession session);
Include
unified_session.h
Parameters
session
FioranoSession to be rollbacked
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

US_close

Purpose
Closes the FioranoSession and resources allocated on behalf of the unified Session
Declaration
mqboolean US_close(FioranoSession session)
Include
unified_session.h
Parameters
session
FioranoSession to be closed
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

US_free

Purpose
Frees all the resources allocated on behalf of the FioranoSession.
Declaration
mqboolean US_free(FioranoSession session)
Include
unified_session.h
Parameters
session
FioranoSession to be freed

US_unsubscribe

Purpose
Unsubscribes a durable subscription that has been created by a client
This method deletes the state being maintained on behalf of the subscriber by the FioranoMQ server.
It is erroneous for a client to delete a durable subscription while there is an active TopicSubscriber for the subscription, while a consumed message is part of a pending transaction, or has not been acknowledged in the session.
Declaration
mqboolean US_unsubscribe(FioranoSession session, mqstring name)
Include
unified_session.h
Parameters
session
FioranoSession using which the subscription is to be unsubscribed
name
The name used to identify this subscription
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

US_createTopic

Purpose
Creates a topic identity given a topic name.
Declaration
Topic US_createTopic(FioranoSession session, mqstring topicName)
Include
unified_session.h
Parameters
session
FioranoSession using which the topic is to be created
Topicname
Name of the Topic for which reference is to be returned.
Return Values
Topic
A Topic with the given name; NULL if an error occurs

US_createTemporaryTopic

Purpose
Creates a temporary topic. Lifetime of the topic is that of the FioranoConnection, unless deleted earlier.
Declaration
TemporaryTopic US_createTemporaryTopic(FioranoSession session)
Include
unified_session.h
Parameters
session
FioranoSession using which the temporary topic is to be created
Return Values
TemporaryTopic
A temporary topic identity; NULL if an error occurs

US_createQueue

Purpose
Creates a queue identity given a Queue name.
Declaration
Queue US_createQueue(FioranoSession session, mqstring queueName)
Include
unified_session.h
Parameters
session
FioranoSession using which the queue is to be created
queueName
Name of this queue
Return Values
Queue
A Queue with the given name

US_createTemporaryQueue

Purpose
Creates a temporary queue. Lifetime of the temporary queue is that of the FioranoConnection, unless deleted earlier.
Declaration
TemporaryQueue US_createTemporaryQueue(FioranoSession session)
Include
unified_session.h
Parameters
session
FioranoSession using which the temporary queue is to be created
Return Values
TemporaryQueue
A temporary queue identity

US_createQueueSender

Purpose
Creates a QueueSender to send messages to the specified destination (queue).
Declaration
QueueSender US_createQueueSender(FioranoSession session, Destination destination)
Include
unified_session.h
Parameters
Session
FioranoSession using which the sender is to be created
destination
The destination (queue) to be accessed
Return Values
QueueSender
Newly created QueueSender, NULL if an error occurs

US_createPublisher

Purpose
Creates a Publisher for the specified destination (topic).
A client uses a FioranoMessageProducerto publish messages on a topic. Each time a client creates a FioranoMessageProduceron a topic, it defines a new sequence of messages that have no ordering relationship with the messages it has previously sent.
Declaration
FioranoMessageProducerUS_createTopicPublisher(FioranoSession session, Destination destination)
Include
unified_session.h
Parameters
session
FioranoSession using which the publisher is to be created
destination
The destination (topic) to publish to
Return Values
TopicPublisher
Newly created TopicPublisher, NULL if an error occurs

FMP_send

Purpose
sends a message to the destination on which the producer is created. Uses the default delivery mode, timeToLive and priority of the destination.
Declaration
mqboolean FMP_send(FioranoMessageProducer producer, Message msg)
Include
fiorano_message_producer.h
Parameters
producer
FioranoMessageProducer that is to be used to publish the message
msg
The message to be published
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

FMP_sendWithParams

Purpose
sends a message to the destination on which the producer is created. Uses the delivery mode, timeToLive and priority given as arguments.
Declaration
mqboolean FMP_sendWithParams(FioranoMessageProducer producer, Message msg, mqint deliveryMode, mqint priority, mqlong timeToLive)
Include
fiorano_message_producer.h
Parameters
producer
FioranoMessageProducer that is to be used to publish the message
msg
The message to be published
deliveryMode
The delivery mode to use
priority
Priority for this message
timeToLive
Lifetime (in milliseconds) of the message
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

FMP_sendWithDestination

Purpose
sends a message to the destination specified. Uses the default delivery mode, timeToLive and priority of the destination.
Declaration
mqboolean FMP_sendWithDestination(FioranoMessageProducer producer, Destination destination, Message msg)
Include
fiorano_message_producer.h
Parameters
producer
FioranoMessageProducer that is to be used to publish the message
destination
Destination on which message is to be published
msg
The message to be published
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

FMP_sendWithDestinationParams

Purpose
sends a message to the destination specified. Uses the delivery mode, timeToLive and priority given as arguments.
Declaration
mqboolean FMP_sendWithDestinationParams(FioranoMessageProducer producer, Destination destination, Message msg, mqint deliveryMode, mqint priority, mqlong timeToLive)
Include
fiorano_message_producer.h
Parameters
producer
FioranoMessageProducer that is to be used to publish the message
destination
Destination on which message is to be published
msg
The message to be published
deliveryMode
The delivery mode to use
priority
Priority for this message
timeToLive
Lifetime (in milliseconds) of the message
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

FMP_close

Purpose
Closes the FioranoMessageProducer and the resources allocated on behalf of the FioranoMessageProducer
Declaration
mqboolean FMP_close(FioranoMessageProducer producer)
Include
fiorano_message_producer.h
Parameters
producer
FioranoMessageProducer that is to be closed
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

FMP_free

Purpose
Frees the resources allocated on behalf of the FioranoMessageProducer.
Declaration
void FMP_free(FioranoMessageProducer producer)
Include
fiorano_message_producer.h
Parameters
producer
FioranoMessageProducer that is to be freed

FMP_getDeliveryMode

Purpose
Gets the default delivery mode of the producer.
Declaration
mqint FMP_getDeliveryMode(FioranoMessageProducer producer)
Include
fiorano_message_producer.h
Parameters
producer
FioranoMessageProducer whose delivery mode is desired
Return Values
mqint
The message delivery mode for this message producer

FMP_getDisableMessageID

Purpose
Gets an indication of whether message IDs are disabled.
Declaration
mqboolean FMP_getDisableMessageID(FioranoMessageProducer producer)
Include
fiorano_message_producer.h
Parameters
producer
FioranoMessageProducer for which the messageID disable indication has to be checked
Return Values
mqboolean
An indication of whether message IDs are disabled

FMP_getDisableMessageTimestamp

Purpose
Gets an indication of whether message timestamps are disabled.
Declaration
mqboolean FMP_getDisableMessageTimestamp(FioranoMessageProducer producer)
Include
fiorano_message_producer.h
Parameters
producer
FioranoMessageProducer for which the message timestamp indication has to be checked
Return Values
mqboolean
An indication of whether message IDs are disabled

FMP_getPriority

Purpose
Gets the default priority of the producer.
Declaration
mqint FMP_getPriority(FioranoMessageProducer producer)
Include
fiorano_message_producer.h
Parameters
producer
FioranoMessageProducer whose priority is desired
Return Values
mqint
The message priority for this message producer

FMP_getTimeToLive

Purpose
Gets the default length of time in milliseconds, from its dispatch time, for which a produced message should be retained by the message system.
Declaration
mqlong FMP_getTimeToLive(FioranoMessageProducer producer)
Include
fiorano_message_producer.h
Parameters
producer
FioranoMessageProducer whose message time to live is desired
Return Values
mqlong
The message time to live in milliseconds; zero is unlimited

FMP_setDeliveryMode

Purpose
Sets the default delivery mode of the producer.
Declaration
mqboolean FMP_setDeliveryMode(FioranoMessageProducer producer, mqint deliveryMode)
Include
fiorano_message_producer.h
Parameters
producer
FioranoMessageProducer for whose messages the delivery mode is to be set.
deliveryMode
The message delivery mode for this message producer; legal values are NON_PERSISTENT and PERSISTENT.
For more information, read the CRTL Constants section
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

FMP_setDisableMessageID

Purpose
Sets whether message IDs are disabled for this Topic Publisher.
Declaration
mqboolean FMP_setDisableMessageID(FioranoMessageProducer producer, mqboolean isDisableMessageID)
Include
fiorano_message_producer.h
Parameters
producer
FioranoMessageProducer for which the messageID is to be disabled
isDisableMessageID
Indicates if message IDs are disabled
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

FMP_setDisableMessageTimestamp

Purpose
Sets whether message timestamps are disabled.
Declaration
mqboolean FMP_setDisableMessageTimeStamp(FioranoMessageProducer producer, mqboolean isDisableMsgTimeStamp)
Include
fiorano_message_producer.h
Parameters
producer
FioranoMessageProducer for which the message timestamp is to be disabled
isDisableMsgTimeStamp
Indicates if message timestamps are disabled
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

FMP_setPriority

Purpose
Sets the default priority of the producer.
The JMS API defines ten levels of priority value, with 0 as the lowest priority and 9 as the highest. Clients should consider priorities 0-4 as gradations of normal priority and priorities 5-9 as gradations of expedited priority. Priority is set to 4 by default.
Declaration
mqboolean FMP_setPriority(FioranoMessageProducer producer, mqint value)
Include
fiorano_message_producer.h
Parameters
producer
FioranoMessageProducer for which the default priority is to be set
value
The message priority for this message producer; must be a value between 0 and 9
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

FMP_setTimeToLive

Purpose
Sets the default length of time in milliseconds, from its dispatch time, for which a produced message should be retained by the message system.
By default, Time to live is set to zero.
Declaration
mqboolean FMP_setTimeToLive(FioranoMessageProducer producer, mqlong value)
Include
fiorano_message_producer.h
Parameters
producer
FioranoMessageProducer for which the time to live is to be set
value
The message time to live in milliseconds; zero is unlimited
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

FMC_close

Purpose
Closes the FioranoMessageConsumer and the resources allocated on behalf of the FioranoMessageProducer
Declaration
mqboolean FMC_close(FioranoMessageConsumer consumer)
Include
fiorano_message_consumer.h
Parameters
consumer
FioranoMessageConsumer that is to be closed
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

FMC_free

Purpose
Frees the resources allocated on behalf of the FioranoMessageConsumer.
Declaration
void FMC_free(FioranoMessageConsumer consumer)
Include
fiorano_message_consumer.h
Parameters
consumer
FioranoMessageConsumer that is to be freed

FMC_start

Purpose
starts the FioranoMessageConsumer after which it starts receiving messages.
Declaration
mqboolean FMC_start(FioranoMessageConsumer consumer)
Include
fiorano_message_consumer.h
Parameters
consumer
FioranoMessageConsumer that is to be started
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

FMC_stop

Purpose
Stops the FioranoMessageConsumer after which it cannot receive messages.
Declaration
mqboolean FMC_stop(FioranoMessageConsumer consumer)
Include
fiorano_message_consumer.h
Parameters
consumer
FioranoMessageConsumer that is to be stopped
Return Values
mqboolean
TRUE if successful, FALSE if an error occurs

Adaptavist ThemeBuilder EngineAtlassian Confluence