WebSphere Message Service Clients for C/C++ and .NET, Version 1.2 作業系統: Linux, Windows

IBytesMessage

位元組訊息是一種其主體包含一個位元組串流的訊息。

繼承階層:
IBM.XMS.IPropertyContext
   |
   +----IBM.XMS.IMessage
           |
           +----IBM.XMS.IBytesMessage

相關參考
位元組訊息

.NET 內容

.NET 內容摘要:
.NET 內容 說明
BodyLength 在訊息主體為唯讀時,取得訊息主體的長度(以位元組計)。

BodyLength – 取得主體長度

介面:
Int64 BodyLength    
    {
      get;
    }

在訊息主體為唯讀時,取得訊息主體的長度(以位元組計)。

所傳回的值會是整個主體的長度, 而不管讀取訊息的游標目前位於何處。

異常狀況:
  • XMSException
  • MessageNotReadableException

方法

方法摘要:
方法 說明
ReadBoolean 從位元組訊息串流中讀取 Boolean 值。
ReadSignedByte 從位元組訊息串流中讀取下一個位元組, 以當成一個帶正負號的 8 位元整數。
ReadBytes 在位元組訊息串流中,從游標的現行位置開始讀取位元組陣列。
ReadChar 從位元組訊息串流中讀取下兩個位元組,以當成一個字元。
ReadDouble 從位元組訊息串流中讀取下 8 個位元組, 以當成一個倍精準度浮點數。
ReadFloat 從位元組訊息串流中讀取下 4 個位元組, 以當成一個浮點數。
ReadInt 從位元組訊息串流中讀取下 4 個位元組, 以當成一個帶正負號的 32 位元整數。
ReadLong 從位元組訊息串流中讀取下 8 個位元組, 以當成一個帶正負號的 64 位元整數。
ReadShort 從位元組訊息串流中讀取下 2 個位元組, 以當成一個帶正負號的 16 位元整數。
ReadByte 從位元組訊息串流中讀取下一個位元組, 以當成一個不帶正負號的 8 位元整數。
ReadUnsignedShort 從位元組訊息串流中讀取下 2 個位元組, 以當成一個不帶正負號的 16 位元整數。
ReadUTF 從位元組訊息串流讀取一個以 UTF-8 編碼的字串。
Reset 將訊息主體變成唯讀模式, 並將游標重新定位在位元組訊息串流開頭。
WriteBoolean 將 Boolean 值寫入位元組訊息串流中。
WriteByte 將位元組寫入位元組訊息串流中。
WriteBytes 將位元組陣列寫入位元組訊息串流中。
WriteBytes 按照指定長度所定義的,將局部的位元組陣列寫入位元組訊息串流中。
WriteChar 將字元當成 2 位元組寫入位元組訊息串流中, 並從次序高的位元組開始。
WriteDouble 將倍精準度浮點數轉換成長整數, 並將長整數當成 8 位元組寫入位元組訊息串流中,且從次序高的位元組開始。
WriteFloat 將浮點數轉換成整數, 並將整數當成 4 位元組寫入位元組訊息串流中,且從次序高的位元組開始。
WriteInt 將整數當成 4 位元組寫入位元組訊息串流中, 並從次序高的位元組開始。
WriteLong 將長整數當成 8 位元組寫入位元組訊息串流中, 並從次序高的位元組開始。
WriteObject 將指定的物件寫入位元組訊息串流中。
WriteShort 將短整數當成 2 位元組寫入位元組訊息串流中, 並從次序高的位元組開始。
WriteUTF 將以 UTF-8 編碼的字串寫入位元組訊息串流中。

ReadBoolean – 讀取 Boolean 值

介面:
Boolean ReadBoolean();

從位元組訊息串流中讀取 Boolean 值。

參數:
傳回:
所讀取的 Boolean 值。
異常狀況:
  • XMSException
  • MessageNotReadableException
  • MessageEOFException

ReadSignedByte – 讀取位元組

介面:
Int16   ReadSignedByte();

從位元組訊息串流中讀取下一個位元組, 以當成一個帶正負號的 8 位元整數。

參數:
傳回:
所讀取的位元組。
異常狀況:
  • XMSException
  • MessageNotReadableException
  • MessageEOFException

ReadBytes – 讀取多個位元組

介面:
Int32   ReadBytes(Byte[] array);                    
    Int32   ReadBytes(Byte[] array, Int32 length);  

在位元組訊息串流中,從游標的現行位置開始讀取位元組陣列。

參數:
array(輸出)
內含所讀取之位元組陣列的緩衝區。如果在呼叫前,要從串流中讀取的剩餘位元組數, 大於或等於緩衝區長度,則會填入緩衝區中。否則,緩衝區只是被局部填入所有剩餘的位元組。

如果您在輸入中指定一個空值指標, 則方法會略過位元組而不會讀取。如果在呼叫前,要從串流中讀取的剩餘位元組數, 大於或等於緩衝區的長度,則所略過的位元組數等於緩衝區長度。否則,會略過所有剩餘的位元組。

length(輸入)
緩衝區的長度(以位元組計)
傳回:
要讀入緩衝區中的位元組數。如果緩衝區只被局部填入, 則其值小於緩衝區長度,這表示已無位元組要讀取。在呼叫前,如果串流中已無留待讀取的位元組, 則其值為 XMSC_END_OF_STREAM

如果您在輸入中指定一個空值指標, 則方法不會傳回任何值。

異常狀況:
  • XMSException
  • MessageNotReadableException
  • MessageEOFException

ReadChar – 讀取字元

介面:
Char    ReadChar();

從位元組訊息串流中讀取下兩個位元組,以當成一個字元。

參數:
傳回:
所讀取的字元。
異常狀況:
  • XMSException
  • MessageNotReadableException
  • MessageEOFException

ReadDouble – 讀取倍精準度浮點數

介面:
Double  ReadDouble();

從位元組訊息串流中讀取下 8 個位元組, 以當成一個倍精準度浮點數。

參數:
傳回:
所讀取的倍精準度浮點數。
異常狀況:
  • XMSException
  • MessageNotReadableException
  • MessageEOFException

ReadFloat – 讀取浮點數

介面:
Single  ReadFloat();

從位元組訊息串流中讀取下 4 個位元組, 以當成一個浮點數。

參數:
傳回:
所讀取的浮點數。
異常狀況:
  • XMSException
  • MessageNotReadableException
  • MessageEOFException

ReadInt – 讀取整數

介面:
Int32   ReadInt();

從位元組訊息串流中讀取下 4 個位元組, 以當成一個帶正負號的 32 位元整數。

參數:
傳回:
所讀取的整數。
異常狀況:
  • XMSException
  • MessageNotReadableException
  • MessageEOFException

ReadLong – 讀取長整數

介面:
Int64   ReadLong();

從位元組訊息串流中讀取下 8 個位元組, 以當成一個帶正負號的 64 位元整數。

參數:
傳回:
所讀取的長整數。
異常狀況:
  • XMSException
  • MessageNotReadableException
  • MessageEOFException

ReadShort – 讀取短整數

介面:
Int16   ReadShort();

從位元組訊息串流中讀取下 2 個位元組, 以當成一個帶正負號的 16 位元整數。

參數:
傳回:
所讀取的短整數。
異常狀況:
  • XMSException
  • MessageNotReadableException
  • MessageEOFException

ReadByte – 讀取不帶正負號的位元組

介面:
Byte    ReadByte();

從位元組訊息串流中讀取下一個位元組, 以當成一個不帶正負號的 8 位元整數。

參數:
傳回:
所讀取的位元組。
異常狀況:
  • XMSException
  • MessageNotReadableException
  • MessageEOFException

ReadUnsignedShort – 讀取不帶正負號的短整數

介面:
Int32   ReadUnsignedShort();

從位元組訊息串流中讀取下 2 個位元組, 以當成一個不帶正負號的 16 位元整數。

參數:
傳回:
所讀取的不帶正負號短整數。
異常狀況:
  • XMSException
  • MessageNotReadableException
  • MessageEOFException

ReadUTF – 讀取 UTF 字串

介面:
String  ReadUTF();

從位元組訊息串流讀取一個以 UTF-8 編碼的字串。

參數:
傳回:
封裝所讀取之字串的 String 物件。
異常狀況:
  • XMSException
  • MessageNotReadableException
  • MessageEOFException

Reset – 重設

介面:
void Reset();

將訊息主體變成唯讀模式, 並將游標重新定位在位元組訊息串流開頭。

參數:
傳回:
Void
異常狀況:
  • XMSException
  • MessageNotReadableException

WriteBoolean – 寫入 Boolean 值

介面:
void  WriteBoolean(Boolean value);

將 Boolean 值寫入位元組訊息串流中。

參數:
value(輸入)
要寫入的 Boolean 值。
傳回:
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

繼承的內容和方法


Reference topic

使用條款 | 評比此網頁

時間戳記前次更新: 25 Apr 2006
(C) Copyright IBM Corporation 2005. All Rights Reserved.
本資訊中心採用 Eclipse 技術。(http://www.eclipse.org)