Provide support for ODV related services. Module to facilitate listening/retrieval of printer unsolicited messaging related to ODV. More...
#include <OdvMonitor.h>
Public Types | |
typedef void(^ | OdvReportCallback) (OdvReport *report) |
A callback type for ODV report changes. | |
Instance Methods | |
(instancetype) | - initWithTcpComm: |
Initializes a new instance with the given TCP communication object. | |
(instancetype) | - initWithJsonComm: |
Initializes a new instance with the given JSON communication object. | |
(instancetype) | - initWithCommDescriptor: |
Constructor called when creating a connection managed by the SDK. | |
(void) | - SetOdvReportListening: |
Sets whether ODV report listening is enabled. | |
Properties | |
BOOL | odvReportListening |
Enable/disable listening/parsing unsolicited ODV reports sent from printer. | |
OdvReportCallback | odvReportCallback |
Holds the function to call when ODV reports are received. Function must match the signature of OdvReportNotice. | |
Provide support for ODV related services. Module to facilitate listening/retrieval of printer unsolicited messaging related to ODV.
Unsolicited messages, if enabled on printer, can be sent at any time. This module requires a constant "status" connection to the printer's management port in order to listen for any messaging sent out by printer.
- OdvReportCallback |
A callback type for ODV report changes.
report | The new ODV report. |
- (instancetype) initWithCommDescriptor: | (NSString *) | commDescriptor |
Constructor called when creating a connection managed by the SDK.
commDescriptor is descriptor for the communication used to connect with printer.
TCP descriptor format: "ip" or "ip:port"
e.g. "127.0.0.1" or "127.0.0.1:3007"
If port is not provided, default value is used.
commDescriptor | The communication descriptor. |
- (instancetype) initWithJsonComm: | (JsonComm *) | mgmtComm |
Initializes a new instance with the given JSON communication object.
mgmtComm | The JSON communication object. |
- (instancetype) initWithTcpComm: | (TcpComm *) | connection |
Initializes a new instance with the given TCP communication object.
connection | The TCP communication object. |
- (void) SetOdvReportListening: | (BOOL) | value |
Sets whether ODV report listening is enabled.
value | YES to enable listening, NO to disable. |
|
readwritenonatomiccopy |
Holds the function to call when ODV reports are received. Function must match the signature of OdvReportNotice.
The parameter passed into the function is an OdvReport object representing the ODV report received.
|
readwritenonatomicassign |
Enable/disable listening/parsing unsolicited ODV reports sent from printer.
Note that this must be enabled in order to receive any notifications (OdvReportCallback) when barcode reports are received.