UniPRT SDK  v1.0.0.0
UniPRT.Sdk.Comm.IComm 介面 參考文件

Interface to a communication connection. 更多...

類別UniPRT.Sdk.Comm.IComm的繼承圖:
UniPRT.Sdk.Comm.AComm UniPRT.Sdk.Comm.TcpConnection

公開方法(Public Methods)

void Close ()
 Closes a connection.
 
void Open ()
 Opens a connection.
 
byte[] Read ()
 Read all bytes available.
 
void Read (BinaryWriter binDataIn)
 Reads all bytes available into the stream passed in.
 
void WaitForData (int msTimeOut)
 等待數據可用 BytesAvailable 在當前線程。當前線程休眠直到接收到數據或超時。阻塞調用。 更多...
 
void Write (BinaryReader binReader)
 從輸入流寫入輸出流 更多...
 
void Write (byte[] dataOut)
 Writes all bytes from the array passed in.
 
void WriteAndWaitForResponse (BinaryWriter binDataIn, BinaryReader binDataOut, int responseStartTimeOut, int responseEndTimeOut, string completetionToken)
 將 binDataOut 流數據寫入輸出流,並將接收到的數據返回到 binDataIn 流中。返回的數據是接收到的任何數據或達到接收的完成令牌。如果沒有回應則在返回前等待超時。 更多...
 
byte[] WriteAndWaitForResponse (byte[] dataOut, int responseStartTimeOut, int responseEndTimeOut, string completetionToken)
 將字節數據寫入輸出流並返回接收到的數據。返回的數據是接收到的任何數據或達到接收的完成令牌。在返回前等待回應超時。 更多...
 

屬性(properties)

int BytesAvailable [get]
 Number of bytes available to read. This is estimate and number can change as data is received.
 
bool Connected [get]
 true if connection is established
 
string Descriptor [get]
 string descriptor of the connection.
 

詳細描述

Interface to a communication connection.

TODO Raul: Should add use of "Pipes" for more efficient I/O operations. e.g. "demultiplexer" (single input to multiple outputs) for input to have multiple "listeners" to data received.

函式成員說明文件

◆ WaitForData()

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

等待數據可用 BytesAvailable 在當前線程。當前線程休眠直到接收到數據或超時。阻塞調用。

參數
[in]msTimeOut如果未接收到數據則在返回前的毫秒超時時間。

實作於 UniPRT.Sdk.Comm.AComm.

◆ Write()

void UniPRT.Sdk.Comm.IComm.Write ( BinaryReader  binReader)

從輸入流寫入輸出流

參數
[in]binReader要發送的來源數據

實作於 UniPRT.Sdk.Comm.AComm.

◆ WriteAndWaitForResponse() [1/2]

void UniPRT.Sdk.Comm.IComm.WriteAndWaitForResponse ( BinaryWriter  binDataIn,
BinaryReader  binDataOut,
int  responseStartTimeOut,
int  responseEndTimeOut,
string  completetionToken 
)

將 binDataOut 流數據寫入輸出流,並將接收到的數據返回到 binDataIn 流中。返回的數據是接收到的任何數據或達到接收的完成令牌。如果沒有回應則在返回前等待超時。

參數
[out]binDataIn目標流以存儲從連接接收到的回應。
[in]binDataOut
要寫入連接的來源流數據。
[in]responseStartTimeOut等待接收到第一個數據的超時時間(毫秒)。第一個字節的時間。
[in]responseEndTimeOut沒有接收到新數據的超時時間(毫秒)。最後一個字節後的時間。
[in]completetionToken指示預期回應結束的字符串令牌。如果只是想等待寫入數據後的回應,可以是空字符串。

實作於 UniPRT.Sdk.Comm.AComm.

◆ WriteAndWaitForResponse() [2/2]

byte [] UniPRT.Sdk.Comm.IComm.WriteAndWaitForResponse ( byte[]  dataOut,
int  responseStartTimeOut,
int  responseEndTimeOut,
string  completetionToken 
)

將字節數據寫入輸出流並返回接收到的數據。返回的數據是接收到的任何數據或達到接收的完成令牌。在返回前等待回應超時。

傳回值
byte[]從連接接收到的字節數組。 返回的數據是接收到的任何數據或達到完成標記時的數據。
參數
[in]dataOut
要寫入連接的來源字節數組。
[in]responseStartTimeOut等待接收到第一個數據的超時時間(毫秒)。第一個字節的時間。
[in]responseEndTimeOut沒有接收到新數據的超時時間(毫秒)。最後一個字節後的時間。
[in]completetionToken指示預期回應結束的字符串令牌。如果只是想等待寫入數據後的回應,可以是空字符串。

實作於 UniPRT.Sdk.Comm.AComm.