JsonSDK.cpp 文件参考

#include "pch.h"
#include "framework.h"
#include "JsonSDK.h"
#include "JsonMng.h"
#include "RfidMonitor.h"
#include "OdvMonitor.h"
#include "PrinterMonitor.h"

JsonSDK.cpp 的引用(Include)关系图:

枚举
enum	INFO_TYP { ODV_TYP = 0 , RFID_TYP , PRINTER_TYP }

函数
DLLEXVOID	MessengerGet (CObject *ptrComm, COMM_TYP commTyp, int maxInputMsgCapacity, bool usingDataPort)
	建立一个频道，用于发送/接收管理讯息，并指定最大容量。
DLLEXVOID	MessengerRelease ()
	释放讯息传输接口资源
DLLEXVOID	MessengerSendMsg (char *strCommand, char *strContent)
	向打印机发送管理指令和数据/内容。
DLLEXVOID	MessengerReadNextMsg (const char **strNextMsg)
	读取已经从打印机异步接收的下一则讯息。
DLLEXVOID	MessengerSendMsgAndWaitForResponse (char *strCommand, char *strContent, int maxWaitTimeSecs, const char **strResponse)
	将管理命令和数据/内容发送到打印机，并等待 maxWaitTimeSecs 秒的回应。
DLLEXINT	MessengerUnreadMsgCount ()
	获取未读訊息的数量。
DLLEXVOID	RfidMonitorConnection (char *lpAddress)
	使用网络接口连接打印机以启用 RFID 监控功能。
DLLEXVOID	OdvMonitorConnection (char *lpAddress)
	使用网络接口连接打印机以启用 ODV 监控功能。
DLLEXVOID	PrinterMonitorConnection (char *lpAddress, INFO_TYP InfoTyp)
	使用网络接口连接打印机以启用打印机监控功能。
DLLEXVOID	GetPrinterInfo (stPrinterInfo *pPrtInfo, INFO_TYP InfoTyp)
	获取打印机功能的相关資訊。
DLLEXBOOL	GetRfidReportListening ()
	获取 RFID 报告监听的标志。
DLLEXVOID	SetRfidReportListening (bool value)
	设置 RFID 报告监听的标志。
DLLEXBOOL	GetOdvReportListening ()
	获取 ODV 报告监听的标志。
DLLEXVOID	SetOdvReportListening (bool value)
	设置 ODV 报告监听的标志。
DLLEXVOID	RfidMonitorDispose ()
	释放 RFID 监控资源。
DLLEXVOID	OdvMonitorDispose ()
	释放 ODV 监控资源。
DLLEXVOID	PrinterMonitorDispose (INFO_TYP InfoTyp)
	释放打印机监控资源。
DLLEXVOID	SetRfidReportCallback (void callback(const RfidReport &report))
	设置一个回调函数来获取 RFID 报告。
DLLEXVOID	SetOdvReportCallback (void callback(const OdvReport &report))
	设置一个回调函数来获取 ODV报告。
DLLEXVOID	SetEngineStatusListening (bool value)
	设置打印机报告监听引擎状态的标志。
DLLEXVOID	SetDisplayStatusListening (bool value)
	设置打印机报告监听屏幕状态的标志。
DLLEXVOID	SetAlertStatusListening (bool value)
	设置打印机报告监听警报状态的标志。
DLLEXBOOL	GetEngineStatusListening ()
	获取引擎状态监听的标志。
DLLEXBOOL	GetDisplayStatusListening ()
	获取显示状态监听的标志。
DLLEXBOOL	GetAlertStatusListening ()
	获取警报状态监听的标志。
DLLEXVOID	SetEngineStatusCallback (void callback(const std::string &engineState))
	设置打印机报告监听警报状态的标志。
DLLEXVOID	SetDisplayStatusCallback (void callback(const std::vector< std::string > &newDisplayText))
	设置打印机报告监听屏幕状态的标志。
DLLEXVOID	SetAlertStatusCallback (void callback(const std::vector< std::string > &alert))
	设置回调函数来获取警报状态。
DLLEXPCHAR	GetPrinterAllValues (CObject *ptrComm, COMM_TYP commTyp, bool usingDataPort)
	获取打印机的所有设置。
DLLEXPCHAR	GetPrinterValue (CObject *ptrComm, COMM_TYP commTyp, bool usingDataPort, const char *key)
	获取打印机的单一设置。
DLLEXPCHAR	GetPrinterValues (CObject *ptrComm, COMM_TYP commTyp, bool usingDataPort, const std::vector< std::string > &keys)
	获取打印机的多个设置。
DLLEXBOOL	SetPrinterValue (CObject *ptrComm, COMM_TYP commTyp, bool usingDataPort, const char *key, const char *value)
	设置打印机的单一设置。
DLLEXBOOL	SetPrinterValues (CObject *ptrComm, COMM_TYP commTyp, bool usingDataPort, std::map< std::string, std::string > *keysToSet)
	设置打印机的多个设置。
DLLEXPCHAR	GetPrinterProperties (CObject *ptrComm, COMM_TYP commTyp, bool usingDataPort, const char *key)
	获取打印机的单一属性。
DLLEXPCHAR	GetPrinterPropertiesEx (CObject *ptrComm, COMM_TYP commTyp, bool usingDataPort, const char *keys[], size_t count)
	获取打印机的多个属性。
DLLEXPCHAR	GetPrinterAllProperties (CObject *ptrComm, COMM_TYP commTyp, bool usingDataPort)
	获取打印机的所有属性。
DLLEXVOID	FreeString (char *str)
	释放字符串资源。
DLLEXPCHAR	GetPrinterConfig (CObject *ptrComm, COMM_TYP commTyp, bool usingDataPort, int CfgNumber)
	获取打印机的单一组态设定。
DLLEXBOOL	SetPrinterConfig (CObject *ptrComm, COMM_TYP commTyp, bool usingDataPort, char *pConfig)
	设置打印机的单一组态设定。
DLLEXPCHAR	GetPrinterAllConfig (CObject *ptrComm, COMM_TYP commTyp, bool usingDataPort)
	获取打印机的所有组态设定。

变量
CJsonSDKApp	theApp
JsonMessenger	gJsonMessenger
RfidMonitor	gRfidMonitor
RfidReport	gRfidReport
OdvMonitor	gOdvMonitor
PrinterMonitor	gPrinterMonitor_Rfid
PrinterMonitor	gPrinterMonitor_Odv
PrinterMonitor	gPrinterMonitor
static std::string	AllMsg

枚举类型说明

INFO_TYP

enum INFO_TYP

枚举值
ODV_TYP
RFID_TYP
PRINTER_TYP

函数说明

FreeString()

DLLEXVOID FreeString

(

char *

str

)

释放字符串资源。

参数

[in]

str

: 字符串资源

返回

无

程序代码

FreeString(AllProperties);

GetAlertStatusListening()

DLLEXBOOL GetAlertStatusListening

(

)

获取警报状态监听的标志。

返回

bool

GetDisplayStatusListening()

DLLEXBOOL GetDisplayStatusListening

(

)

获取显示状态监听的标志。

返回

bool

GetEngineStatusListening()

DLLEXBOOL GetEngineStatusListening

(

)

获取引擎状态监听的标志。

返回

bool

GetOdvReportListening()

DLLEXBOOL GetOdvReportListening

(

)

获取 ODV 报告监听的标志。

返回

bool

GetPrinterAllConfig()

DLLEXPCHAR GetPrinterAllConfig	(	CObject *	ptrComm,
		COMM_TYP	commTyp,
		bool	usingDataPort )

获取打印机的所有组态设定。

参数

[in]	commPtr	: 界面指针
[in]	commTyp	: 接口种类
[in]	usingDataPort	: 使用数据端口传输, 默认是 false

返回

char*

程序代码

char* pAllConfig = pGetPrinterAllConfig(commPtr, commTyp, false);

GetPrinterAllProperties()

DLLEXPCHAR GetPrinterAllProperties	(	CObject *	ptrComm,
		COMM_TYP	commTyp,
		bool	usingDataPort )

获取打印机的所有属性。

参数

[in]	commPtr	: 界面指针
[in]	commTyp	: 接口种类
[in]	usingDataPort	: 使用数据端口传输, 默认是 false

返回

char*

程序代码

char* AllProperties = GetPrinterAllProperties(commPtr, commTyp, false);

GetPrinterAllValues()

DLLEXPCHAR GetPrinterAllValues	(	CObject *	ptrComm,
		COMM_TYP	commTyp,
		bool	usingDataPort )

获取打印机的所有设置。

参数

[in]	commPtr	: 界面指针
[in]	commTyp	: 接口种类
[in]	usingDataPort	: 使用数据端口传输, 默认是 false

返回

char*

程序代码

char* values = GetPrinterAllValues(commPtr, commTyp, false);

GetPrinterConfig()

DLLEXPCHAR GetPrinterConfig	(	CObject *	ptrComm,
		COMM_TYP	commTyp,
		bool	usingDataPort,
		int	CfgNumber )

获取打印机的单一组态设定。

参数

[in]	commPtr	: 界面指针
[in]	commTyp	: 接口种类
[in]	usingDataPort	: 使用数据端口传输, 默认是 false
[in]	CfgNumber	: 组态设定索引值, 范围是 0~8

返回

char*

程序代码

char* pConfig = pGetPrinterConfig(commPtr, commTyp, false, 2);

GetPrinterInfo()

DLLEXVOID GetPrinterInfo	(	stPrinterInfo *	pPrtInfo,
		INFO_TYP	InfoTyp )

获取打印机功能的相关資訊。

参数

[out]	pPrtInfo	: 用来存储打印机資訊的结构体
[in]	InfoTyp	: 设置 RFID 或 ODV 資訊的类型

返回

无

程序代码

PrinterInfo PrtInfo;
GetPrinterInfo(&PrtInfo, INFO_TYP::PRINTER_TYP);

GetPrinterProperties()

DLLEXPCHAR GetPrinterProperties	(	CObject *	ptrComm,
		COMM_TYP	commTyp,
		bool	usingDataPort,
		const char *	key )

获取打印机的单一属性。

参数

[in]	commPtr	: 界面指针
[in]	commTyp	: 接口种类
[in]	usingDataPort	: 使用数据端口传输, 默认是 false
[in]	key	打印机设置的一个键值

返回

char*

程序代码

std::string key = "Speed.Print-mmps";
char* Properties = GetPrinterProperties(commPtr, commTyp, false, key.c_str());

GetPrinterPropertiesEx()

DLLEXPCHAR GetPrinterPropertiesEx	(	CObject *	ptrComm,
		COMM_TYP	commTyp,
		bool	usingDataPort,
		const char *	keys[],
		size_t	count )

获取打印机的多个属性。

参数

[in]	commPtr	: 界面指针
[in]	commTyp	: 接口种类
[in]	usingDataPort	: 使用数据端口传输, 默认是 false
[in]	keyProps	打印机设置的多个键值
[in]	keyCount	键值数量

返回

char*

程序代码

const char* keyProps[] = { "Speed", "Label.Sensor" };
size_t keyCount = sizeof(keyProps) / sizeof(keyProps[0]);
char* PropertiesEx = GetPrinterPropertiesEx(commPtr, commTyp, false, keyProps, keyCount);

GetPrinterValue()

DLLEXPCHAR GetPrinterValue	(	CObject *	ptrComm,
		COMM_TYP	commTyp,
		bool	usingDataPort,
		const char *	key )

获取打印机的单一设置。

参数

[in]	commPtr	: 界面指针
[in]	commTyp	: 接口种类
[in]	usingDataPort	: 使用数据端口传输, 默认是 false
[in]	key	打印机设置的一个键值

返回

char*

程序代码

const std::string& key = "Ethernet.MAC";
char* value = GetPrinterValue(commPtr, commTyp, false, key.c_str());

GetPrinterValues()

DLLEXPCHAR GetPrinterValues	(	CObject *	ptrComm,
		COMM_TYP	commTyp,
		bool	usingDataPort,
		const std::vector< std::string > &	keys )

获取打印机的多个设置。

参数

[in]	commPtr	: 界面指针
[in]	commTyp	: 接口种类
[in]	usingDataPort	: 使用数据端口传输, 默认是 false
[in]	keys	打印机设置的多个键值

返回

char*

程序代码

std::vector<std::string> keys = { "Ethernet.IP", "Ethernet.MAC", "Ethernet.Speed" };
char* values = GetPrinterValue(commPtr, commTyp, false, keys);

GetRfidReportListening()

DLLEXBOOL GetRfidReportListening

(

)

获取 RFID 报告监听的标志。

返回

bool

MessengerGet()

DLLEXVOID MessengerGet	(	CObject *	ptrComm,
		COMM_TYP	commTyp,
		int	maxInputMsgCapacity,
		bool	usingDataPort )

建立一个频道，用于发送/接收管理讯息，并指定最大容量。

参数

[out]	ptrComm	: 界面指针
[in]	commTyp	: 接口种类 enum COMM_TYP { USB_COMM = 0, TCP_COMM, BT_COMM, };
[in]	maxInputMsgCapacity	: 最大讯息输入容量, 默认 MAX_INPUT_MSG_CAPACITY(20)
[in]	usingDataPort	: 使用数据端口传输, 默认是 false

返回

无

程序代码

std::string content;
COMM_TYP commTyp = COMM_TYP::TCP_COMM;
CObject* commPtr = NULL;
MessengerGet(commPtr, commTyp, MAX_INPUT_MSG_CAPACITY, false);

MessengerReadNextMsg()

DLLEXVOID MessengerReadNextMsg

(

const char **

strNextMsg

)

读取已经从打印机异步接收的下一则讯息。

参数

[out]

strNextMsg

: 用来存储下一个返回訊息的缓冲区

返回

无

程序代码

const char* strNextMsg = new char[MAX_BUFSIZE];
MessengerReadNextMsg(&strNextMsg);
if (!_bAsyncListening)
       break;
if (strNextMsg != NULL)
{
  std::string str(strNextMsg);
  currentText += str;
  std::cout << std::endl;
  std::cout << std::endl;
  std::cout << "Response:";
  std::cout << currentText << std::endl;
}
delete[] strNextMsg;

MessengerRelease()

DLLEXVOID MessengerRelease

(

)

释放讯息传输接口资源

返回

无

程序代码

MessengerRelease();

MessengerSendMsg()

DLLEXVOID MessengerSendMsg	(	char *	strCommand,
		char *	strContent )

向打印机发送管理指令和数据/内容。

参数

[in]	strCommand	: 管理指令字符串
[in]	strContent	: 管理数据/内容字符串

返回

无

程序代码

char* pCmdStr = (char*)"Cfg.Item";
std::string content;
content += "{\r\n";
content += "\"Speed\" : null,\r\n";
content += "\"ODV.Symbol\" : null,\r\n";
content += "\"Label.Sensor\":null\r\n";
content += "}\r\n";
const char* pContentStr = content.c_str();
MessengerSendMsg(pCmdStr, (char*)pContentStr);

MessengerSendMsgAndWaitForResponse()

DLLEXVOID MessengerSendMsgAndWaitForResponse	(	char *	strCommand,
		char *	strContent,
		int	maxWaitTimeSecs,
		const char **	strResponse )

将管理命令和数据/内容发送到打印机，并等待 maxWaitTimeSecs 秒的回应。

参数

[in]	strCommand	: 一个管理命令字符串
[in]	strContent	: 一个管理数据/内容字符串
[in]	maxWaitTimeSecs	: 最大等待时间
[out]	strResponse	: 用来存储 JSON 字符串回应的缓冲区

返回

无

程序代码

#define MAX_WAIT_TIME_SECS 5
char* pCmdStr = (char*)"Cfg.Item";
std::string content;
content += "{\r\n";
content += "\"Speed\" : null,\r\n";
content += "\"ODV.Symbol\" : null,\r\n";
content += "\"Label.Sensor\":null\r\n";
content += "}\r\n";
const char* pContentStr = content.c_str();
const char* strResponse = NULL;
MessengerSendMsgAndWaitForResponse(pCmdStr, (char*)pContentStr, MAX_WAIT_TIME_SECS, &strResponse);

MessengerUnreadMsgCount()

DLLEXINT MessengerUnreadMsgCount

(

)

获取未读訊息的数量。

返回

int

程序代码

int iUnreadMsgCount = MessengerUnreadMsgCount();

OdvMonitorConnection()

DLLEXVOID OdvMonitorConnection

(

char *

lpAddress

)

使用网络接口连接打印机以启用 ODV 监控功能。

参数

[in]

lpAddress

: IP 地址

返回

无

程序代码

std::string ptrIpOdv = "10.0.10.171";
pOdvMonitorConnection((char*)ptrIpOdv.c_str());

OdvMonitorDispose()

DLLEXVOID OdvMonitorDispose

(

)

释放 ODV 监控资源。

返回

无

PrinterMonitorConnection()

DLLEXVOID PrinterMonitorConnection	(	char *	lpAddress,
		INFO_TYP	InfoTyp )

使用网络接口连接打印机以启用打印机监控功能。

参数

[in]

lpAddress

: IP 地址

返回

无

程序代码

std::string ptrIpRfid = "10.0.10.178";
RfidMonitorConnection((char*)ptrIpRfid.c_str());
PrinterMonitorConnection((char*)ptrIpRfid.c_str(), INFO_TYP::RFID_TYP);

PrinterMonitorDispose()

DLLEXVOID PrinterMonitorDispose

(

INFO_TYP

InfoTyp

)

释放打印机监控资源。

返回

无

RfidMonitorConnection()

DLLEXVOID RfidMonitorConnection

(

char *

lpAddress

)

使用网络接口连接打印机以启用 RFID 监控功能。

参数

[in]

lpAddress

: IP 地址

返回

无

程序代码

std::string ptrIpRfid = "10.0.10.178";
RfidMonitorConnection((char*)ptrIpRfid.c_str());

RfidMonitorDispose()

DLLEXVOID RfidMonitorDispose

(

)

释放 RFID 监控资源。

返回

无

SetAlertStatusCallback()

DLLEXVOID SetAlertStatusCallback

(

void

callbackconst std::vector< std::string > &alert

)

设置回调函数来获取警报状态。

参数

[in]

callback

:回调函数

返回

无

程序代码

SetAlertStatusCallback(PtrAlertNoticeListener);

SetAlertStatusListening()

DLLEXVOID SetAlertStatusListening

(

bool

value

)

设置打印机报告监听警报状态的标志。

参数

[in]

value

: 用来设置打印机报告监听的标志

返回

无

程序代码

SetAlertStatusListening(true);

SetDisplayStatusCallback()

DLLEXVOID SetDisplayStatusCallback

(

void

callbackconst std::vector< std::string > &newDisplayText

)

设置打印机报告监听屏幕状态的标志。

参数

[in]

callback

:回调函数

返回

无

程序代码

SetEngineStatusCallback(PtrEngineStatusNoticeListener);

SetDisplayStatusListening()

DLLEXVOID SetDisplayStatusListening

(

bool

value

)

设置打印机报告监听屏幕状态的标志。

参数

[in]

value

: 用来设置打印机报告监听的标志

返回

无

程序代码

SetDisplayStatusListening(true);

SetEngineStatusCallback()

DLLEXVOID SetEngineStatusCallback

(

void

callbackconst std::string &engineState

)

设置打印机报告监听警报状态的标志。

参数

[in]

callback

:回调函数

返回

无

程序代码

SetEngineStatusCallback(PtrEngineStatusNoticeListener);

SetEngineStatusListening()

DLLEXVOID SetEngineStatusListening

(

bool

value

)

设置打印机报告监听引擎状态的标志。

参数

[in]

value

: 用来设置打印机报告监听的标志

返回

无

程序代码

SetEngineStatusListening(true);

SetOdvReportCallback()

DLLEXVOID SetOdvReportCallback

(

void

callbackconst OdvReport &report

)

设置一个回调函数来获取 ODV报告。

参数

[in]

callback

:回调函数

返回

无

程序代码

SetOdvReportCallback(OdvReportCallback);

SetOdvReportListening()

DLLEXVOID SetOdvReportListening

(

bool

value

)

设置 ODV 报告监听的标志。

参数

[in]

value

: 用来设置 ODV 报告监听的标志

返回

无

程序代码

SetRfidReportListening(true);

SetPrinterConfig()

DLLEXBOOL SetPrinterConfig	(	CObject *	ptrComm,
		COMM_TYP	commTyp,
		bool	usingDataPort,
		char *	pConfig )

设置打印机的单一组态设定。

参数

[in]	commPtr	: 界面指针
[in]	commTyp	: 接口种类
[in]	usingDataPort	: 使用数据端口传输, 默认是 false
[in]	pConfig	: 组态设定

返回

bool

程序代码

char* pConfig = pGetPrinterConfig(commPtr, commTyp, false, 2);
bool result = pSetPrinterConfig(commPtr, commTyp, false, pConfig);

SetPrinterValue()

DLLEXBOOL SetPrinterValue	(	CObject *	ptrComm,
		COMM_TYP	commTyp,
		bool	usingDataPort,
		const char *	key,
		const char *	value )

设置打印机的单一设置。

参数

[in]	commPtr	: 界面指针
[in]	commTyp	: 接口种类
[in]	usingDataPort	: 使用数据端口传输, 默认是 false
[in]	key	打印机设置的一个键值
[in]	value	一個打印机设置值

返回

bool

程序代码

const std::string _key = "Ethernet.Speed";
const std::string _value = "eAutomatic";
bool result = SetPrinterValue(commPtr, commTyp, false, _key.c_str(), _value.c_str());

SetPrinterValues()

DLLEXBOOL SetPrinterValues	(	CObject *	ptrComm,
		COMM_TYP	commTyp,
		bool	usingDataPort,
		std::map< std::string, std::string > *	keysToSet )

设置打印机的多个设置。

参数

[in]	commPtr	: 界面指针
[in]	commTyp	: 接口种类
[in]	usingDataPort	: 使用数据端口传输, 默认是 false
[in]	keysToSet	打印机设置的多个键值

返回

bool

程序代码

std::map<std::string, std::string> keyValues = {
     {"Ethernet.Speed", "eAutomatic"},
      {"Image.Width-in", "3.5"}
   };
bool result = SetPrinterValues(commPtr, commTyp, false, &keyValues);

SetRfidReportCallback()

DLLEXVOID SetRfidReportCallback

(

void

callbackconst RfidReport &report

)

设置一个回调函数来获取 RFID 报告。

参数

[in]

callback

:回调函数

返回

无

程序代码

SetRfidReportCallback(RfidReportCallback);

SetRfidReportListening()

DLLEXVOID SetRfidReportListening

(

bool

value

)

设置 RFID 报告监听的标志。

参数

[in]

value

: 用来设置 RFID 报告监听的标志

返回

无

程序代码

SetRfidReportListening(true);

变量说明

AllMsg

std::string AllMsg

static

gJsonMessenger

JsonMessenger gJsonMessenger

gOdvMonitor

OdvMonitor gOdvMonitor

gPrinterMonitor

PrinterMonitor gPrinterMonitor

gPrinterMonitor_Odv

PrinterMonitor gPrinterMonitor_Odv

gPrinterMonitor_Rfid

PrinterMonitor gPrinterMonitor_Rfid

gRfidMonitor

RfidMonitor gRfidMonitor

gRfidReport

RfidReport gRfidReport

theApp

CJsonSDKApp theApp