IBytesMessage

字节消息是其主体由字节流组成的消息。

继承层次结构：

IBM.XMS.IPropertyContext
   |
   +----IBM.XMS.IMessage
           |
           +----IBM.XMS.IBytesMessage

.NET 个属性

.NET 属性的摘要:

.NET 属性	描述
BodyLength	在消息主体为只读时，用于获取消息主体的长度（以字节计）。

BodyLength - 获取主体长度

接口：

Int64 BodyLength    
    {
      get;
    }

在消息主体为只读时，用于获取消息主体的长度（以字节计）。

返回的值是整个主体的长度，与读取消息时光标当前所在的位置无关。

异常：

XMSException
MessageNotReadableException

方法

方法汇总：

方法	描述
ReadBoolean	从字节消息流中读取布尔值。
ReadSignedByte	从字节消息流中读取下一个字节作为有符号的 8 位整数。
ReadBytes	从字节消息流中读取字节数组，从光标当前位置开始。
ReadChar	从字节消息流中读取接下来的 2 个字节作为一个字符。
ReadDouble	从字节消息流中读取接下来的 8 个字节作为一个双精度浮点数。
ReadFloat	从字节消息流中读取接下来的 4 个字节作为一个浮点数。
ReadInt	从字节消息流中读取接下来的 4 个字节作为一个有符号的 32 位整数。
ReadLong	从字节消息流中读取接下来的 8 个字节作为一个有符号的 64 位整数。
ReadShort	从字节消息流中读取接下来的 2 个字节作为一个有符号的 16 位整数。
ReadByte	从字节消息流中读取下一个字节作为无符号的 8 位整数。
ReadUnsignedShort	从字节消息流中读取接下来的 2 个字节作为一个无符号的 16 位整数。
ReadUTF	从字节消息流中读取采用 UTF-8 编码的字符串。
重置	将消息主体置于只读方式，并将光标重新定位在字节消息流的开始位置。
WriteBoolean	将布尔值写入字节消息流中。
WriteByte	将一个字节写入字节消息流中。
WriteBytes	将字节数组写入字节消息流中。
WriteBytes	将部分字节数组写入字节消息流中（如指定长度所定义）。
WriteChar	将一个字符作为 2 个字节（首先是高位字节）写入字节消息流中。
WriteDouble	将双精度浮点数转换为长整数，并将此长整数作为 8 个字节（首先是高位字节）写入字节消息流中。
WriteFloat	将浮点数转换为整数，并将此整数作为 4 个字节（首先是高位字节）写入字节消息流中。
WriteInt	将整数作为 4 个字节（首先是高位字节）写入字节消息流中。
WriteLong	将长整数作为 8 个字节（首先是高位字节）写入字节消息流中。
WriteObject	将指定的对象写入字节消息流中。
WriteShort	将短整数作为 2 个字节（首先是高位字节）写入字节消息流中。
WriteUTF	将采用 UTF-8 编码的字符串写入字节消息流中。

ReadBoolean - 读取布尔值

接口：

Boolean ReadBoolean();

从字节消息流中读取布尔值。

参数：

None

返回：

读取的布尔值。

异常：

XMSException
MessageNotReadableException
MessageEOFException

ReadSignedByte - 读取单个字节

接口：

Int16   ReadSignedByte();

从字节消息流中读取下一个字节作为有符号的 8 位整数。

参数：

None

返回：

读取的字节。

异常：

XMSException
MessageNotReadableException
MessageEOFException

ReadBytes - 读取多个字节

接口：

Int32   ReadBytes(Byte[] array);                
Int32   ReadBytes(Byte[] array, Int32 length);

从字节消息流中读取字节数组，从光标当前位置开始。

参数：

array（输出）: 包含所读取的字节数组的缓冲区。如果在调用前要从流中读取的剩余字节数大于或等于缓冲区长度，那么缓冲区将填满。否则，将使用所有剩余字节部分填充缓冲区。
如果在输入上指定空指针，那么此方法会跳过字节，而不读取这些字节。如果在调用前要从流中读取的剩余字节数大于或等于缓冲区长度，那么跳过的字节数等于缓冲区长度。否则，将跳过所有剩余字节。光标保留在字节消息流中要读取的下一个位置。
length（输入）: 缓冲区的长度（以字节计）

返回：

读入到缓冲区的字节数。如果部分填充缓冲区，那么该值小于缓冲区长度，这表明不存在待读取的剩余字节。如果在调用前流中不存在待读取的剩余字节，那么该值为 XMSC_END_OF_STREAM。

如果在输入上指定空指针，那么此方法不返回任何值。

异常：

XMSException
MessageNotReadableException

ReadChar - 读取字符

接口：

Char    ReadChar();

从字节消息流中读取接下来的 2 个字节作为一个字符。

参数：

None

返回：

读取的字符。

异常：

XMSException
MessageNotReadableException
MessageEOFException

ReadDouble - 读取双精度浮点数

接口：

Double  ReadDouble();

从字节消息流中读取接下来的 8 个字节作为一个双精度浮点数。

参数：

None

返回：

读取的双精度浮点数。

异常：

XMSException
MessageNotReadableException
MessageEOFException

ReadFloat - 读取浮点数

接口：

Single  ReadFloat();

从字节消息流中读取接下来的 4 个字节作为一个浮点数。

参数：

None

返回：

读取的浮点数。

异常：

XMSException
MessageNotReadableException
MessageEOFException

ReadInt - 读取整数

接口：

Int32   ReadInt();

从字节消息流中读取接下来的 4 个字节作为一个有符号的 32 位整数。

参数：

None

返回：

读取的整数。

异常：

XMSException
MessageNotReadableException
MessageEOFException

ReadLong - 读取长整数

接口：

Int64   ReadLong();

从字节消息流中读取接下来的 8 个字节作为一个有符号的 64 位整数。

参数：

None

返回：

读取的长整数。

异常：

XMSException
MessageNotReadableException
MessageEOFException

ReadShort - 读取短整数

接口：

Int16   ReadShort();

从字节消息流中读取接下来的 2 个字节作为一个有符号的 16 位整数。

参数：

None

返回：

读取的短整数。

异常：

XMSException
MessageNotReadableException
MessageEOFException

ReadByte - 读取无符号的字节

接口：

Byte    ReadByte();

从字节消息流中读取下一个字节作为无符号的 8 位整数。

参数：

None

返回：

读取的字节。

异常：

XMSException
MessageNotReadableException
MessageEOFException

ReadUnsignedShort - 读取无符号的短整数

接口：

Int32   ReadUnsignedShort();

从字节消息流中读取接下来的 2 个字节作为一个无符号的 16 位整数。

参数：

None

返回：

读取的无符号的短整数。

异常：

XMSException
MessageNotReadableException
MessageEOFException

ReadUTF - 读取 UTF 字符串

接口：

String  ReadUTF();

从字节消息流中读取采用 UTF-8 编码的字符串。

注意：调用ReadUTF() 之前，请确保缓冲区的光标指向字节信息流的起始位置。

参数：

None

返回：

用于封装读取的字符串的 String 对象。

异常：

XMSException
MessageNotReadableException
MessageEOFException

Reset - 重置

接口：

void Reset();

将消息主体置于只读方式，并将光标重新定位在字节消息流的开始位置。

参数：

None

返回：

Void

异常：

XMSException
MessageNotReadableException

WriteBoolean - 写入布尔值

接口：

void  WriteBoolean(Boolean value);

将布尔值写入字节消息流中。

参数：

value（输入）: 要写入的布尔值。

返回：

Void

异常：

XMSException
MessageNotWritableException

WriteByte - 写入单个字节

接口：

void  WriteByte(Byte value);
void  WriteSignedByte(Int16 value);

将一个字节写入字节消息流中。

参数：

value（输入）: 要写入的字节。

返回：

Void

异常：

XMSException
MessageNotWritableException

WriteBytes - 写入多个字节

接口：

void  WriteBytes(Byte[] value);

将字节数组写入字节消息流中。

参数：

value（输入）: 要写入的字节数组。

返回：

Void

异常：

XMSException
MessageNotWritableException

WriteBytes - 写入部分字节数组

接口：

void  WriteBytes(Byte[] value, int offset, int length);

将部分字节数组写入字节消息流中（如指定长度所定义）。

参数：

value（输入）: 要写入的字节数组。
offset（输入）: 要写入的字节数组的起点。
length（输入）: 要写入的字节数。

返回：

Void

异常：

XMSException
MessageNotWritableException

WriteChar - 写入字符

接口：

void  WriteChar(Char value);

将一个字符作为 2 个字节（首先是高位字节）写入字节消息流中。

参数：

value（输入）: 要写入的字符。

返回：

Void

异常：

XMSException
MessageNotWritableException

WriteDouble - 写入双精度浮点数

接口：

void  WriteDouble(Double value);

将双精度浮点数转换为长整数，并将此长整数作为 8 个字节（首先是高位字节）写入字节消息流中。

参数：

value（输入）: 要写入的双精度浮点数。

返回：

Void

异常：

XMSException
MessageNotWritableException

WriteFloat - 写入浮点数

接口：

void  WriteFloat(Single value);

将浮点数转换为整数，并将此整数作为 4 个字节（首先是高位字节）写入字节消息流中。

参数：

value（输入）: 要写入的浮点数。

返回：

Void

异常：

XMSException
MessageNotWritableException

WriteInt - 写入整数

接口：

void  WriteInt(Int32 value);

将整数作为 4 个字节（首先是高位字节）写入字节消息流中。

参数：

value（输入）: 要写入的整数。

返回：

Void

异常：

XMSException
MessageNotWritableException

WriteLong - 写入长整数

接口：

void  WriteLong(Int64 value);

将长整数作为 8 个字节（首先是高位字节）写入字节消息流中。

参数：

value（输入）: 要写入的长整数。

返回：

Void

异常：

XMSException
MessageNotWritableException

WriteObject - 写入对象

接口：

void  WriteObject(Object value);

将指定的对象写入字节消息流中。

参数：

value（输入）: 要写入的对象，此对象必须是对基本类型的引用。

返回：

Void

异常：

XMSException
MessageNotWritableException

WriteShort - 写入短整数

接口：

void  WriteShort(Int16 value);

将短整数作为 2 个字节（首先是高位字节）写入字节消息流中。

参数：

value（输入）: 要写入的短整数。

返回：

Void

异常：

XMSException
MessageNotWritableException

WriteUTF - 写入 UTF 字符串

接口：

void  WriteUTF(String value);

将采用 UTF-8 编码的字符串写入字节消息流中。

参数：

value（输入）: 用于封装待写入字符串的 String 对象。

返回：

Void

异常：

XMSException
MessageNotWritableException

继承的属性和方法

从 IMessage 接口继承以下属性:

JMSCorrelationID、JMSDeliveryMode、JMSDestination、JMSExpiration、JMSMessageID、JMSPriority、JMSRedelivered、JMSReplyTo、JMSTimestamp、 JMSType、属性

从 IMessage 接口继承以下方法:

清除主体,清除属性,PropertyExists

从 IPropertyContext 接口继承以下方法: