|
virtual | ~StreamMessage () |
|
virtual ValueType | getNextValueType () const =0 |
| Returns the value type for the element in the StreamMessage. More...
|
|
virtual bool | readBoolean () const =0 |
| Reads a Boolean from the Stream message stream. More...
|
|
virtual void | writeBoolean (bool value)=0 |
| Writes a boolean to the Stream message stream as a 1-byte value. More...
|
|
virtual unsigned char | readByte () const =0 |
| Reads a Byte from the Stream message stream. More...
|
|
virtual void | writeByte (unsigned char value)=0 |
| Writes a byte to the Stream message stream as a 1-byte value. More...
|
|
virtual int | readBytes (std::vector< unsigned char > &value) const =0 |
| Reads a byte array from the Stream message stream. More...
|
|
virtual void | writeBytes (const std::vector< unsigned char > &value)=0 |
| Writes a byte array to the Stream message stream using the vector size as the number of bytes to write. More...
|
|
virtual int | readBytes (unsigned char *buffer, int length) const =0 |
| Reads a portion of the Stream message stream. More...
|
|
virtual void | writeBytes (const unsigned char *value, int offset, int length)=0 |
| Writes a portion of a byte array to the Stream message stream. More...
|
|
virtual char | readChar () const =0 |
| Reads a Char from the Stream message stream. More...
|
|
virtual void | writeChar (char value)=0 |
| Writes a char to the Stream message stream as a 1-byte value. More...
|
|
virtual float | readFloat () const =0 |
| Reads a 32 bit float from the Stream message stream. More...
|
|
virtual void | writeFloat (float value)=0 |
| Writes a float to the Stream message stream as a 4 byte value. More...
|
|
virtual double | readDouble () const =0 |
| Reads a 64 bit double from the Stream message stream. More...
|
|
virtual void | writeDouble (double value)=0 |
| Writes a double to the Stream message stream as a 8 byte value. More...
|
|
virtual short | readShort () const =0 |
| Reads a 16 bit signed short from the Stream message stream. More...
|
|
virtual void | writeShort (short value)=0 |
| Writes a signed short to the Stream message stream as a 2 byte value. More...
|
|
virtual unsigned short | readUnsignedShort () const =0 |
| Reads a 16 bit unsigned short from the Stream message stream. More...
|
|
virtual void | writeUnsignedShort (unsigned short value)=0 |
| Writes a unsigned short to the Stream message stream as a 2 byte value. More...
|
|
virtual int | readInt () const =0 |
| Reads a 32 bit signed integer from the Stream message stream. More...
|
|
virtual void | writeInt (int value)=0 |
| Writes a signed int to the Stream message stream as a 4 byte value. More...
|
|
virtual long long | readLong () const =0 |
| Reads a 64 bit long from the Stream message stream. More...
|
|
virtual void | writeLong (long long value)=0 |
| Writes a long long to the Stream message stream as a 8 byte value. More...
|
|
virtual std::string | readString () const =0 |
| Reads an ASCII String from the Stream message stream. More...
|
|
virtual void | writeString (const std::string &value)=0 |
| Writes an ASCII String to the Stream message stream. More...
|
|
virtual void | reset ()=0 |
| Puts the message body in read-only mode and repositions the stream of bytes to the beginning. More...
|
|
virtual | ~Message () |
|
virtual Message * | clone () const =0 |
| Clone this message exactly, returns a new instance that the caller is required to delete. More...
|
|
virtual void | acknowledge () const =0 |
| Acknowledges all consumed messages of the session of this consumed message. More...
|
|
virtual void | clearBody ()=0 |
| Clears out the body of the message. More...
|
|
virtual void | clearProperties ()=0 |
| Clears out the message body. More...
|
|
virtual std::vector< std::string > | getPropertyNames () const =0 |
| Retrieves the property names. More...
|
|
virtual bool | propertyExists (const std::string &name) const =0 |
| Indicates whether or not a given property exists. More...
|
|
virtual ValueType | getPropertyValueType (const std::string &name) const =0 |
| Returns the value type for the given property key. More...
|
|
virtual bool | getBooleanProperty (const std::string &name) const =0 |
| Gets a boolean property. More...
|
|
virtual unsigned char | getByteProperty (const std::string &name) const =0 |
| Gets a byte property. More...
|
|
virtual double | getDoubleProperty (const std::string &name) const =0 |
| Gets a double property. More...
|
|
virtual float | getFloatProperty (const std::string &name) const =0 |
| Gets a float property. More...
|
|
virtual int | getIntProperty (const std::string &name) const =0 |
| Gets a int property. More...
|
|
virtual long long | getLongProperty (const std::string &name) const =0 |
| Gets a long property. More...
|
|
virtual short | getShortProperty (const std::string &name) const =0 |
| Gets a short property. More...
|
|
virtual std::string | getStringProperty (const std::string &name) const =0 |
| Gets a string property. More...
|
|
virtual void | setBooleanProperty (const std::string &name, bool value)=0 |
| Sets a boolean property. More...
|
|
virtual void | setByteProperty (const std::string &name, unsigned char value)=0 |
| Sets a byte property. More...
|
|
virtual void | setDoubleProperty (const std::string &name, double value)=0 |
| Sets a double property. More...
|
|
virtual void | setFloatProperty (const std::string &name, float value)=0 |
| Sets a float property. More...
|
|
virtual void | setIntProperty (const std::string &name, int value)=0 |
| Sets a int property. More...
|
|
virtual void | setLongProperty (const std::string &name, long long value)=0 |
| Sets a long property. More...
|
|
virtual void | setShortProperty (const std::string &name, short value)=0 |
| Sets a short property. More...
|
|
virtual void | setStringProperty (const std::string &name, const std::string &value)=0 |
| Sets a string property. More...
|
|
virtual std::string | getCMSCorrelationID () const =0 |
| Gets the correlation ID for the message. More...
|
|
virtual void | setCMSCorrelationID (const std::string &correlationId)=0 |
| Sets the correlation ID for the message. More...
|
|
virtual int | getCMSDeliveryMode () const =0 |
| Gets the DeliveryMode for this message. More...
|
|
virtual void | setCMSDeliveryMode (int mode)=0 |
| Sets the DeliveryMode for this message. More...
|
|
virtual const Destination * | getCMSDestination () const =0 |
| Gets the Destination object for this message. More...
|
|
virtual void | setCMSDestination (const Destination *destination)=0 |
| Sets the Destination object for this message. More...
|
|
virtual long long | getCMSExpiration () const =0 |
| Gets the message's expiration value. More...
|
|
virtual void | setCMSExpiration (long long expireTime)=0 |
| Sets the message's expiration value. More...
|
|
virtual std::string | getCMSMessageID () const =0 |
| The CMSMessageID header field contains a value that uniquely identifies each message sent by a provider. More...
|
|
virtual void | setCMSMessageID (const std::string &id)=0 |
| Sets the message ID. More...
|
|
virtual int | getCMSPriority () const =0 |
| Gets the message priority level. More...
|
|
virtual void | setCMSPriority (int priority)=0 |
| Sets the Priority Value for this message. More...
|
|
virtual bool | getCMSRedelivered () const =0 |
| Gets an indication of whether this message is being redelivered. More...
|
|
virtual void | setCMSRedelivered (bool redelivered)=0 |
| Specifies whether this message is being redelivered. More...
|
|
virtual const cms::Destination * | getCMSReplyTo () const =0 |
| Gets the Destination object to which a reply to this message should be sent. More...
|
|
virtual void | setCMSReplyTo (const cms::Destination *destination)=0 |
| Sets the Destination object to which a reply to this message should be sent. More...
|
|
virtual long long | getCMSTimestamp () const =0 |
| Gets the message timestamp. More...
|
|
virtual void | setCMSTimestamp (long long timeStamp)=0 |
| Sets the message timestamp. More...
|
|
virtual std::string | getCMSType () const =0 |
| Gets the message type identifier supplied by the client when the message was sent. More...
|
|
virtual void | setCMSType (const std::string &type)=0 |
| Sets the message type. More...
|
|
Interface for a StreamMessage.
The stream Messages provides a Message type whose body is a stream of self describing primitive types. The primitive values are read and written using accessors specific to the given types.
StreamMessage objects support the following conversion table. The marked cases must be supported. The unmarked cases must throw a CMSException. The string-to- primitive conversions may throw a runtime exception if the primitive's valueOf() method does not accept it as a valid String representation of the primitive.
A value written as the row type can be read as the column type.
| | boolean byte short char int long float double String byte[]
|----------------------------------------------------------------------
|boolean | X X
|byte | X X X X X
|short | X X X X
|char | X X
|int | X X X
|long | X X
|float | X X X
|double | X X
|String | X X X X X X X X
|byte[] | X
|----------------------------------------------------------------------
- Since
- 1.3