UniPRT SDK v2.0.0.0
 
载入中...
搜索中...
未找到
JsonConfig类 参考

用于通过 JSON 通信管理配置的类。 更多...

#include <JsonConfig.h>

类 JsonConfig 继承关系图:

实例方法

(instancetype) - initWithTcpComm:usingDataPort:
 必须传递一个已打开的 TcpComm 连接,如果需要监听来自打印机的非请求消息,该连接必须保持打开。
 
(instancetype) - initWithBtComm:usingDataPort:
 使用已打开的 BtComm 蓝牙连接初始化。
 
(instancetype) - initWithBleComm:usingDataPort:
 使用已打开的 BleComm 藍牙低功耗連接初始化。
 
(instancetype) - initWithUsbComm:usingDataPort:
 使用已打开的 UsbComm USB 连接初始化。
 
(instancetype) - initWithJsonComm:
 使用给定的 JSON 通信对象初始化一个新实例。
 
(instancetype) - initWithCommDescriptor:
 在创建由 SDK 管理的连接时调用的构造函数。
 
(NSArray< Config * > *) - getAllConfigWithTimeout:
 JsonConfig 对象的析构函数。
 
(Config *) - getConfigWithNumber:timeout:
 获取具有指定编号的配置。
 
(BOOL) - setConfig:pCfg:
 设置指定的配置。
 

详细描述

用于通过 JSON 通信管理配置的类。

成员函数文档

◆ getAllConfigWithTimeout:

- (NSArray< Config * > *) getAllConfigWithTimeout: (int) timeout

JsonConfig 对象的析构函数。

在指定超时时间内获取所有配置。

此方法會在指定的超时时间内,从设备中检索所有可用的配置对象。

参数
timeout等待的最大时间(毫秒)。
返回
一个表示所有配置的 Config 对象数组。

◆ getConfigWithNumber:timeout:

- (Config *) getConfigWithNumber: (int) cfgNumber
timeout: (int) timeout 

获取具有指定编号的配置。

此方法会在指定的超时时间内,检索与给定编号对应的配置对象。

参数
cfgNumber要检索的配置编号。
timeout等待的最大时间(毫秒)。
返回
具有指定编号的配置对象,如果未找到则返回 nil。

◆ initWithBleComm:usingDataPort:

- (instancetype) initWithBleComm: (BleComm *) connection
usingDataPort: (BOOL) usingDataPort 

使用已打开的 BleComm 藍牙低功耗連接初始化。

参数
connectionBLE 通信对象。
usingDataPort是否使用数据端口通信。
返回
一个初始化的 JsonConfig 实例。

◆ initWithBtComm:usingDataPort:

- (instancetype) initWithBtComm: (BtComm *) connection
usingDataPort: (BOOL) usingDataPort 

使用已打开的 BtComm 蓝牙连接初始化。

参数
connection蓝牙通信对象。
usingDataPort是否使用数据端口通信。
返回
一个初始化的 JsonConfig 实例。

◆ initWithCommDescriptor:

- (instancetype) initWithCommDescriptor: (NSString *) commDescriptor

在创建由 SDK 管理的连接时调用的构造函数。

参数
commDescriptor用于连接打印机的通信描述符,TCP 描述符格式:"ip" 或 "ip:port",例如 "127.0.0.1" 或 "127.0.0.1:3007"。如果未提供端口,则使用默认值。
返回
一个初始化的 JsonConfig 实例,如果无法创建对象,则返回 nil。

◆ initWithJsonComm:

- (instancetype) initWithJsonComm: (JsonComm *) mgmtComm

使用给定的 JSON 通信对象初始化一个新实例。

参数
mgmtCommJSON 通信对象。
返回
一个初始化的 JsonConfig 实例,如果无法创建对象,则返回 nil。

◆ initWithTcpComm:usingDataPort:

- (instancetype) initWithTcpComm: (TcpComm *) connection
usingDataPort: (BOOL) usingDataPort 

必须传递一个已打开的 TcpComm 连接,如果需要监听来自打印机的非请求消息,该连接必须保持打开。

参数
connectionTCP 通信对象。
usingDataPort是否使用数据端口通信。
返回
一个初始化的 JsonConfig 实例,如果无法创建对象,则返回 nil。

◆ initWithUsbComm:usingDataPort:

- (instancetype) initWithUsbComm: (UsbComm *) connection
usingDataPort: (BOOL) usingDataPort 

使用已打开的 UsbComm USB 连接初始化。

参数
connectionUSB 通信对象。
usingDataPort是否使用数据端口通信。
返回
一个初始化的 JsonConfig 实例。

◆ setConfig:pCfg:

- (BOOL) setConfig: (Config *)
pCfg: (int) timeout 

设置指定的配置。

此方法会在指定的超时时间内,将给定的配置对象写入设备。

参数
pCfg表示要设置的配置的 Config 对象。
timeout等待的最大时间(毫秒)。
返回
如果配置成功设置,则返回 YES;否则返回 NO。

该类的文档由以下文件生成: