UniPRT SDK v1.0.0.0
 
载入中...
搜索中...
未找到
<IComm>协议 参考

定义通信类接口的协议。 更多...

#include <IComm.h>

类 <IComm> 继承关系图:
AComm TcpComm

构造函数

(void) - close
 关闭通信接口。
 
(void) - open
 打开通信接口。
 
(NSData *) - read
 从通信接口读取数据。
 
(void) - readToBinaryWriter:
 将数据从二进制读取器(输入流)写入输出流。
 
(void) - waitForDataWithTimeout:
 等待数据在当前线程中可用。当前线程将休眠,直到接收到数据或达到超时。这是一个阻塞调用。
 
(void) - writeFromBinaryReader:
 将传入数组中的所有字节写入。
 
(void) - write:
 将数据写入通信接口。
 
(NSData *) - writeAndWaitForResponseToBinaryWriter:fromBinaryReader:responseStartTimeout:responseEndTimeout:completionToken:
 将输入流中的数据写入输出流,并返回输出流中接收到的数据。返回的数据是接收到的任何数据或接收到的完成令牌。等待响应超时后返回。
 
(NSData *) - writeAndWaitForResponse:responseStartTimeOut:responseEndTimeOut:completionToken:
 将字节数据写入输出流并返回接收到的数据。返回的数据是接收到的任何数据或接收到的完成令牌。等待响应超时后返回。
 

属性

NSString * descriptor
 通信接口的描述符。
 
int bytesAvailable
 可读取的字节数。
 
BOOL isConnected
 指示连接是否已建立的标志。
 

详细描述

定义通信类接口的协议。

函数文档

◆ close

- (void) close

关闭通信接口。

AComm , 以及 TcpComm 重载.

◆ open

- (void) open

打开通信接口。

AComm , 以及 TcpComm 重载.

◆ read

- (NSData *) read

从通信接口读取数据。

返回
从接口读取的数据。

AComm , 以及 TcpComm 重载.

◆ readToBinaryWriter:

- (void) readToBinaryWriter: (NSOutputStream *) binDataIn

将数据从二进制读取器(输入流)写入输出流。

参数
binDataIn要写入数据的输出流。

AComm 重载.

◆ waitForDataWithTimeout:

- (void) waitForDataWithTimeout: (NSTimeInterval) msTimeOut

等待数据在当前线程中可用。当前线程将休眠,直到接收到数据或达到超时。这是一个阻塞调用。

参数
msTimeOut在未接收到数据之前返回的超时间隔(毫秒)。

AComm 重载.

◆ write:

- (void) write: (NSData *) dataOut

将数据写入通信接口。

参数
dataOut要写入接口的数据。

AComm , 以及 TcpComm 重载.

◆ writeAndWaitForResponse:responseStartTimeOut:responseEndTimeOut:completionToken:

- (NSData *) writeAndWaitForResponse: (NSData *) text
responseStartTimeOut: (NSTimeInterval) responseStartTimeOut
responseEndTimeOut: (NSTimeInterval) responseEndTimeOut
completionToken: (NSString *) completionToken 

将字节数据写入输出流并返回接收到的数据。返回的数据是接收到的任何数据或接收到的完成令牌。等待响应超时后返回。

参数
text要写入连接的源字节数组。
responseStartTimeOut等待接收到第一个数据的超时间隔(首次字节时间)。
responseEndTimeOut在接收到最后一个字节后如果没有新数据则等待的超时间隔(最后字节时间)。
completionToken表示预期响应结束的字符串令牌。如果在写入数据到连接后只是等待响应,这可以是一个空字符串。
返回
从连接接收到的字节数组。

AComm , 以及 TcpComm 重载.

◆ writeAndWaitForResponseToBinaryWriter:fromBinaryReader:responseStartTimeout:responseEndTimeout:completionToken:

- (NSData *) writeAndWaitForResponseToBinaryWriter: (NSOutputStream *) binDataIn
fromBinaryReader: (NSInputStream *) binDataOut
responseStartTimeout: (int) responseStartTimeOut
responseEndTimeout: (int) responseEndTimeOut
completionToken: (NSString *) completionToken 

将输入流中的数据写入输出流,并返回输出流中接收到的数据。返回的数据是接收到的任何数据或接收到的完成令牌。等待响应超时后返回。

参数
binDataIn用于存储从连接接收到的响应的输出流。
binDataOut要写入连接的输入流数据。
responseStartTimeOut等待接收到第一个数据的超时间隔(首次字节时间)。
responseEndTimeOut在接收到最后一个字节后如果没有新数据则等待的超时间隔(最后字节时间)。
completionToken表示预期响应结束的字符串令牌。如果在写入数据到连接后只是等待响应,这可以是一个空字符串。
返回
从连接接收到的数据。

AComm 重载.

◆ writeFromBinaryReader:

- (void) writeFromBinaryReader: (NSInputStream *) binReader

将传入数组中的所有字节写入。

参数
binReader要从中读取数据的输入流。

AComm 重载.

属性说明

◆ bytesAvailable

- (int) bytesAvailable
readnonatomicassign

可读取的字节数。

◆ descriptor

- (NSString*) descriptor
readnonatomicassign

通信接口的描述符。

◆ isConnected

- (BOOL) isConnected
readnonatomicassign

指示连接是否已建立的标志。


该协议的文档由以下文件生成: