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 成员函数

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 ( )

Close the connection.

com.UniPRT.Sdk.Comm.TcpConnection 内被实现.

被这些函数引用 com.UniPRT.Sdk.Json.JsonCommController.JsonConnection.Dispose().

◆ 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 ( )

Get the string descriptor of the connection.

返回
String descriptor of the connection.

com.UniPRT.Sdk.Comm.TcpConnection 内被实现.

被这些函数引用 com.UniPRT.Sdk.Json.JsonCommController.CreateMgmtComm(), com.UniPRT.Sdk.Json.JsonComm.Dispose() , 以及 com.UniPRT.Sdk.Json.JsonCommController.JsonConnection.JsonConnection().

◆ 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().


该接口的文档由以下文件生成: