UniPRT SDK v1.0.0.0
 
载入中...
搜索中...
未找到
JsonMessenger类 参考

用于管理基于 JSON 的讯息传递的类。 更多...

#include <JsonMessenger.h>

类 JsonMessenger 继承关系图:

构造函数

(instancetype) - initWithCommToPtr:iCommTyp:maxInputMsgCapacity:usingDataPort:
 使用给定的通信指针、通信类型、最大输入讯息容量和数据端口使用标志初始化一个新实例。
 
(NSString *) - sendMsgWithCommand:content:trackNo:
 发送管理命令和数据/内容到印表机。
 
(JsonMng *) - sendMsgAndWaitForResponseWithCommand:content:maxWaitTimeSecs:
 发送管理命令和数据/内容到印表机并等待最大等待时间秒数的响应。
 
(JsonMng *) - readNextMsg
 读取可能从印表机异步接收到的下一条讯息。
 
(void) - sendMsgRawWithDataToSend:
 将内容直接发送到印表机,不进行任何讯息格式化。
 
(void) - dispose
 释放对象,释放所有资源。
 

详细描述

用于管理基于 JSON 的讯息传递的类。

函数文档

◆ dispose

- (void) dispose

释放对象,释放所有资源。

◆ initWithCommToPtr:iCommTyp:maxInputMsgCapacity:usingDataPort:

- (instancetype) initWithCommToPtr: (AComm *) commToPtr
iCommTyp: (CommType) iCommTyp
maxInputMsgCapacity: (int) maxInputMsgCapacity
usingDataPort: (BOOL) usingDataPort 

使用给定的通信指针、通信类型、最大输入讯息容量和数据端口使用标志初始化一个新实例。

如果在从印表机收到更多讯息之前没有读取讯息,则最早的讯息将被丢弃。

如果与印表机的通信通过发送打印数据的相同端口进行,请将 usingDataPort 设置为 true。

这对于正确格式化管理讯息非常重要,以便印表机区分来自打印数据的讯息。

参数
commToPtr通信实例的指针。
iCommTyp通信类型。
maxInputMsgCapacity最大输入讯息容量。
usingDataPort指示是否使用数据端口的标志。
返回
一个初始化的 JsonMessenger 实例,如果无法创建对象,则返回 nil。

◆ readNextMsg

- (JsonMng *) readNextMsg

读取可能从印表机异步接收到的下一条讯息。

返回
表示下一条讯息的 JsonMng 实例。

◆ sendMsgAndWaitForResponseWithCommand:content:maxWaitTimeSecs:

- (JsonMng *) sendMsgAndWaitForResponseWithCommand: (NSString *) command
content: (NSString *) content
maxWaitTimeSecs: (int) maxWaitTimeSecs 

发送管理命令和数据/内容到印表机并等待最大等待时间秒数的响应。

如果在超时之前未收到响应,则返回空对象。

在接收到发送的特定讯息的响应之前,所有讯息都会被丢弃。被丢弃的讯息可能包括在调用此方法之前等待读取的任何未读/旧讯息。

参数
command讯息的命令。
content讯息的内容。
maxWaitTimeSecs最大等待时间(秒)。
返回
表示响应的 JsonMng 实例。

◆ sendMsgRawWithDataToSend:

- (void) sendMsgRawWithDataToSend: (NSString *) dataToSend

将内容直接发送到印表机,不进行任何讯息格式化。

适用于需要在没有任何附加管理讯息格式的情况下发送数据的情况。

如果有特殊的管理讯息或需要在同时用于数据和管理的端口发送的数据,这将用于直接将数据发送到印表机。

参数
dataToSend要发送的数据。

◆ sendMsgWithCommand:content:trackNo:

- (NSString *) sendMsgWithCommand: (NSString *) command
content: (NSString *) content
trackNo: (NSString *) trackNo 

发送管理命令和数据/内容到印表机。

可选的 TrackNo 是发送到印表机的 JSON 命令结构中使用的字段,调用者可以使用它来检查印表机的响应。如果未提供 TrackNo,则会生成一个。

返回的字符串是发送到印表机的 JSON 讯息中使用的 TrackNo 字段,以允许调用者通过比较从印表机接收到的任何响应的 TrackNo 字段来区分与发送的讯息相关的任何响应。

参数
command讯息的命令。
content讯息的内容。
trackNo讯息的跟踪号。
返回
表示发送操作结果的字符串。

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