UniPRT SDK  v1.0.0.0
com.UniPRT.Sdk.Comm.IComm 介面 參考文件
類別com.UniPRT.Sdk.Comm.IComm的繼承圖:
com.UniPRT.Sdk.Comm.AComm com.UniPRT.Sdk.Comm.TcpConnection

公開方法(Public Methods)

String Descriptor ()
 
int BytesAvailable ()
 
boolean Connected ()
 
void Close ()
 
void Open ()
 
byte[] Read ()
 
void Read (OutputStream binDataIn) throws IOException
 
void WaitForData (int msTimeOut)
 等待當前執行緒有可用的資料 BytesAvailable。當前執行緒會休眠直到收到資料或超時為止。此為阻塞呼叫。 更多...
 
void Write (InputStream binReader) throws IOException
 從輸入流寫入輸出流。 更多...
 
void Write (byte[] dataOut)
 
void WriteAndWaitForResponse (OutputStream binDataIn, InputStream binDataOut, int responseStartTimeOut, int responseEndTimeOut, String completionToken) throws IOException
 將 binDataOut 流資料寫入輸出流,並將接收到的資料返回到 binDataIn 流中。返回的資料是收到的資料或收到的完成標記。等待回應超時後返回。 更多...
 
byte[] WriteAndWaitForResponse (byte[] dataOut, int responseStartTimeOut, int responseEndTimeOut, String completionToken) throws IOException
 將位元組資料寫入輸出流並返回接收到的資料。返回的資料是接收到的任何資料或收到的完成標記。等待回應超時後返回。 更多...
 

函式成員說明文件

◆ BytesAvailable()

int com.UniPRT.Sdk.Comm.IComm.BytesAvailable ( )

Get the number of bytes available to read.

傳回值
Number of bytes available to read.

實作於 com.UniPRT.Sdk.Comm.TcpConnection.

被參考於 com.UniPRT.Sdk.Comm.AComm.WaitForData(), 及 com.UniPRT.Sdk.Comm.AComm.WriteAndWaitForResponse().

◆ Close()

void com.UniPRT.Sdk.Comm.IComm.Close ( )

◆ Connected()

boolean com.UniPRT.Sdk.Comm.IComm.Connected ( )

Check if connection is established.

傳回值
true if connection is established, otherwise false.

實作於 com.UniPRT.Sdk.Comm.TcpConnection.

被參考於 com.UniPRT.Sdk.Json.JsonComm.SendAndWaitForMsgFrame().

◆ Descriptor()

String com.UniPRT.Sdk.Comm.IComm.Descriptor ( )

◆ Open()

void com.UniPRT.Sdk.Comm.IComm.Open ( )

◆ Read() [1/2]

byte [] com.UniPRT.Sdk.Comm.IComm.Read ( )

Read all available bytes.

傳回值
Array of bytes read.

實作於 com.UniPRT.Sdk.Comm.TcpConnection.

被參考於 com.UniPRT.Sdk.Comm.AComm.Read(), 及 com.UniPRT.Sdk.Comm.AComm.WriteAndWaitForResponse().

◆ Read() [2/2]

void com.UniPRT.Sdk.Comm.IComm.Read ( OutputStream  binDataIn) throws IOException

Read all available bytes into the stream passed in.

參數
binDataInData input stream.
例外
IOException

實作於 com.UniPRT.Sdk.Comm.AComm.

◆ WaitForData()

void com.UniPRT.Sdk.Comm.IComm.WaitForData ( int  msTimeOut)

等待當前執行緒有可用的資料 BytesAvailable。當前執行緒會休眠直到收到資料或超時為止。此為阻塞呼叫。

參數
[in]msTimeOut在沒有收到資料前返回的毫秒超時。

實作於 com.UniPRT.Sdk.Comm.AComm.

◆ Write() [1/2]

void com.UniPRT.Sdk.Comm.IComm.Write ( byte[]  dataOut)

Write all bytes from the array passed in.

參數
dataOutByte array to write.

實作於 com.UniPRT.Sdk.Comm.TcpConnection.

◆ Write() [2/2]

void com.UniPRT.Sdk.Comm.IComm.Write ( InputStream  binReader) throws IOException

從輸入流寫入輸出流。

參數
[in]binReader要傳送的來源資料。

實作於 com.UniPRT.Sdk.Comm.AComm.

◆ WriteAndWaitForResponse() [1/2]

byte [] com.UniPRT.Sdk.Comm.IComm.WriteAndWaitForResponse ( byte[]  dataOut,
int  responseStartTimeOut,
int  responseEndTimeOut,
String  completionToken 
) throws IOException

將位元組資料寫入輸出流並返回接收到的資料。返回的資料是接收到的任何資料或收到的完成標記。等待回應超時後返回。

傳回值
byte[]從連接接收到的位元組陣列。 返回的資料是接收到的任何資料或收到的完成標記。
參數
[in]dataOut要寫入連接的來源位元組陣列。
[in]responseStartTimeOut等待接收到第一個資料的超時。從第一個字節開始計時。
[in]responseEndTimeOut沒有新資料接收的超時。從最後一個字節後開始計時。
[in]completetionToken標示預期回應結束的字串標記。如果只是想在寫入資料到連接後等待回應,可以是空字串。

實作於 com.UniPRT.Sdk.Comm.AComm.

◆ WriteAndWaitForResponse() [2/2]

void com.UniPRT.Sdk.Comm.IComm.WriteAndWaitForResponse ( OutputStream  binDataIn,
InputStream  binDataOut,
int  responseStartTimeOut,
int  responseEndTimeOut,
String  completionToken 
) throws IOException

將 binDataOut 流資料寫入輸出流,並將接收到的資料返回到 binDataIn 流中。返回的資料是收到的資料或收到的完成標記。等待回應超時後返回。

參數
[out]binDataIn用於存儲從連接接收到的回應的目標流。
[in]binDataOut寫入連接的來源流資料。
[in]responseStartTimeOut等待接收到第一個資料的超時。從第一個字節開始計時。
[in]responseEndTimeOut沒有新資料接收的超時。從最後一個字節後開始計時。
[in]completetionToken標示預期回應結束的字串標記。如果只是想在寫入資料到連接後等待回應,可以是空字串。

實作於 com.UniPRT.Sdk.Comm.AComm.

被參考於 com.UniPRT.Sdk.Json.JsonComm.SendAndWaitForMsgFrame().


此介面(interface) 文件是由下列檔案中產生: