WebLogic Messaging API Class Library

IBytesMessage Interface

An IBytesMessage object is used to send a message containing a stream of uninterpreted bytes. It inherits from the IMessage interface and adds a bytes message body. The receiver of the message supplies the interpretation of the bytes. Numeric and UTF types are automatically stored and retrieved using big endian byte ordering -- for more information on endian byte ordering see the JMS .NET client programmer's guide.

The primitive types can be written explicitly using methods for each type. They may also be written generically as objects. For instance, a call to IBytesMessage.WriteInt(6) is equivalent to IBytesMessage.WriteObject((int)6). Both forms are provided, because the explicit form is convenient for static programming, and the object form is needed when types are not known at compile time.

When the message is first created, and when ClearBody is called, the body of the message is in write-only mode. After the first call to Reset has been made, the message body is in read-only mode. After a message has been sent, the client that sent it can retain and modify it without affecting the message that has been sent. The same message object can be sent multiple times. When a message has been received, JMS has internally called Reset so that the message body is in read-only mode for the client.

If ClearBody is called on a message in read-only mode, the message body is cleared and the message is in write-only mode.

If a client attempts to read a message in write-only mode, a MessageNotReadableException is thrown.

If a client attempts to write a message in read-only mode, a MessageNotWriteableException is thrown.

For a list of all members of this type, see IBytesMessage Members.

public interface IBytesMessage : WebLogic.Messaging.IMessage

Requirements

Namespace: WebLogic.Messaging

Assembly: WebLogic.Messaging (in WebLogic.Messaging.dll)

See Also

IBytesMessage Members | WebLogic.Messaging Namespace | CreateBytesMessage | IMapMessage | IMessage | IObjectMessage | IStreamMessage | ITextMessage