Provide support for ODV related services. Module to facilitate listening/retrieval of printer unsolicited messaging related to ODV. More...
Public Member Functions | |
OdvReportNotice | GetOdvReportCallback () |
Inherited from IOdvMonitor.OdvReportListening. More... | |
void | SetOdvReportCallback (OdvReportNotice callback) |
Holds the function to call when ODV reports received. Function must match signature of OdvReportNotice. More... | |
boolean | GetOdvReportListening () |
Inherited from IOdvMonitor.OdvReportListening. More... | |
void | SetOdvReportListening (boolean listening) |
Enable/disable listening/parsing unsolicited ODV reports sent from printer. More... | |
OdvMonitor (TcpConnection connection) | |
Must pass an opened comm connection that can remain opened for listening for unsolicited ODV reports. More... | |
OdvMonitor (JsonComm mgmtComm) | |
Constructor called when an mgmt comm object already exists for listening for mgmt msgs. More... | |
OdvMonitor (String commDescriptor) | |
Constructor called when creating a connection managed by the SDK. More... | |
void | Dispose () |
void | close () throws Exception |
Protected Member Functions | |
void | Dispose (boolean disposing) |
void | finalize () throws Throwable |
Private Member Functions | |
void | triggerCallbackForOdvReport (OdvReport report) |
void | MsgListenerCtrlRefresh () |
Map< String, String > | MsgParser_OdvReport (String mgmtReportFrame) |
void | CallbackForOdvReport (OdvReport odvReport) |
Private Attributes | |
TcpConnection | _ptrComm |
JsonComm | _mgmtComm |
Channel< String > | _msgsFromPtr |
String | _myMgmtId = "" |
AtomicBoolean | _mgmtMsgListening = new AtomicBoolean(false) |
AtomicBoolean | _printerJobReporting = new AtomicBoolean(false) |
AtomicBoolean | _odvReportListening = new AtomicBoolean(false) |
ExecutorService | _executor = Executors.newSingleThreadExecutor() |
Future<?> | _listenerTask |
ConcurrentLinkedQueue< String > | _mgmtFilteredMsgs = new ConcurrentLinkedQueue<>() |
OdvReportNotice | OdvReportCallback |
boolean | _sdkManagedComm = false |
String | _managedDescriptor = "" |
boolean | _disposed = false |
Static Private Attributes | |
static final int | MAX_MSGS_FROM_PTR = 100 |
static final int | MAX_ODV_MSGS = 2 |
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.
Result after sending print job with barcode to printer and getting back barcode report.
com.UniPRT.Sdk.Json.OdvMonitor.OdvMonitor | ( | TcpConnection | connection | ) |
Must pass an opened comm connection that can remain opened for listening for unsolicited ODV reports.
A connection is necessary to send/receive msgs.
References com.UniPRT.Sdk.Json.OdvMonitor._mgmtComm, com.UniPRT.Sdk.Json.OdvMonitor._myMgmtId, com.UniPRT.Sdk.Json.OdvMonitor._ptrComm, com.UniPRT.Sdk.Json.JsonStringBuilder.GetRandomObjectId_Json(), and com.UniPRT.Sdk.Json.OdvMonitor.OdvReportCallback.
com.UniPRT.Sdk.Json.OdvMonitor.OdvMonitor | ( | JsonComm | mgmtComm | ) |
Constructor called when an mgmt comm object already exists for listening for mgmt msgs.
JsonComm object per printer that is listening and parsing fully formed mgmt msgs and forwarding to all mgmt msg listeners.
References com.UniPRT.Sdk.Json.OdvMonitor._mgmtComm, com.UniPRT.Sdk.Json.OdvMonitor._myMgmtId, com.UniPRT.Sdk.Json.JsonStringBuilder.GetRandomObjectId_Json(), and com.UniPRT.Sdk.Json.OdvMonitor.OdvReportCallback.
com.UniPRT.Sdk.Json.OdvMonitor.OdvMonitor | ( | String | 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.
References com.UniPRT.Sdk.Json.OdvMonitor._managedDescriptor, com.UniPRT.Sdk.Json.OdvMonitor._mgmtComm, com.UniPRT.Sdk.Json.OdvMonitor._myMgmtId, com.UniPRT.Sdk.Json.OdvMonitor._sdkManagedComm, com.UniPRT.Sdk.Json.JsonCommController.CreateMgmtComm(), com.UniPRT.Sdk.Json.JsonStringBuilder.GetRandomObjectId_Json(), com.UniPRT.Sdk.Json.JsonCommController.Instance(), and com.UniPRT.Sdk.Json.OdvMonitor.OdvReportCallback.
|
private |
void com.UniPRT.Sdk.Json.OdvMonitor.close | ( | ) | throws Exception |
References com.UniPRT.Sdk.Json.OdvMonitor.Dispose().
Referenced by com.UniPRT.Sdk.Json.OdvMonitor.finalize().
void com.UniPRT.Sdk.Json.OdvMonitor.Dispose | ( | ) |
Referenced by com.UniPRT.Sdk.Json.OdvMonitor.close().
|
protected |
|
protected |
OdvReportNotice com.UniPRT.Sdk.Json.OdvMonitor.GetOdvReportCallback | ( | ) |
Inherited from IOdvMonitor.OdvReportListening.
Implements com.UniPRT.Sdk.Json.IOdvMonitor.
References com.UniPRT.Sdk.Json.OdvMonitor.OdvReportCallback.
boolean com.UniPRT.Sdk.Json.OdvMonitor.GetOdvReportListening | ( | ) |
Inherited from IOdvMonitor.OdvReportListening.
Implements com.UniPRT.Sdk.Json.IOdvMonitor.
References com.UniPRT.Sdk.Json.OdvMonitor._odvReportListening.
|
private |
References com.UniPRT.Sdk.Json.OdvMonitor._executor, com.UniPRT.Sdk.Json.OdvMonitor._listenerTask, com.UniPRT.Sdk.Json.OdvMonitor._mgmtComm, com.UniPRT.Sdk.Json.OdvMonitor._mgmtFilteredMsgs, com.UniPRT.Sdk.Json.OdvMonitor._mgmtMsgListening, com.UniPRT.Sdk.Json.OdvMonitor._msgsFromPtr, com.UniPRT.Sdk.Json.OdvMonitor._odvReportListening, com.UniPRT.Sdk.Json.OdvMonitor._printerJobReporting, com.UniPRT.Sdk.Json.JsonComm.ChannelListenerJson(), com.UniPRT.Sdk.Json.JsonStringTokenizer.GetKeyValue(), com.UniPRT.Sdk.Json.JsonStringTokenizer.GetMsgIdExpectedOnResponse_Json(), com.UniPRT.Sdk.Json.OdvReportNotice.handle(), com.UniPRT.Sdk.Json.OdvMonitor.MAX_MSGS_FROM_PTR, com.UniPRT.Sdk.Json.OdvMonitor.MAX_ODV_MSGS, com.UniPRT.Sdk.Json.OdvMonitor.MsgParser_OdvReport(), com.UniPRT.Sdk.Json.OdvMonitor.OdvReportCallback, com.UniPRT.Sdk.Json.OdvReport.RawReport, com.UniPRT.Sdk.Mgmt.Channel< T >.Take(), and com.UniPRT.Sdk.Mgmt.MgmtChannelFilterType.UNSOLICITED_MSGS_ONLY.
Referenced by com.UniPRT.Sdk.Json.OdvMonitor.SetOdvReportListening().
|
private |
void com.UniPRT.Sdk.Json.OdvMonitor.SetOdvReportCallback | ( | OdvReportNotice | callback | ) |
Holds the function to call when ODV reports received. Function must match signature of OdvReportNotice.
The parameter passed into the function is a OdvReport object representing the ODV report received.
Implements com.UniPRT.Sdk.Json.IOdvMonitor.
void com.UniPRT.Sdk.Json.OdvMonitor.SetOdvReportListening | ( | boolean | listening | ) |
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.
Implements com.UniPRT.Sdk.Json.IOdvMonitor.
References com.UniPRT.Sdk.Json.OdvMonitor._mgmtComm, com.UniPRT.Sdk.Json.OdvMonitor._myMgmtId, com.UniPRT.Sdk.Json.OdvMonitor._odvReportListening, com.UniPRT.Sdk.Json.JsonStringBuilder.CreateMsgFrame_Json(), com.UniPRT.Sdk.Json.OdvMonitor.MsgListenerCtrlRefresh(), and com.UniPRT.Sdk.Json.JsonComm.SendAndWaitForResponse().
|
private |
|
private |
Referenced by com.UniPRT.Sdk.Json.OdvMonitor.Dispose(), and com.UniPRT.Sdk.Json.OdvMonitor.finalize().
|
private |
Referenced by com.UniPRT.Sdk.Json.OdvMonitor.MsgListenerCtrlRefresh().
|
private |
Referenced by com.UniPRT.Sdk.Json.OdvMonitor.MsgListenerCtrlRefresh().
|
private |
Referenced by com.UniPRT.Sdk.Json.OdvMonitor.Dispose(), and com.UniPRT.Sdk.Json.OdvMonitor.OdvMonitor().
|
private |
|
private |
Referenced by com.UniPRT.Sdk.Json.OdvMonitor.MsgListenerCtrlRefresh().
|
private |
Referenced by com.UniPRT.Sdk.Json.OdvMonitor.MsgListenerCtrlRefresh().
|
private |
Referenced by com.UniPRT.Sdk.Json.OdvMonitor.MsgListenerCtrlRefresh().
|
private |
|
private |
|
private |
Referenced by com.UniPRT.Sdk.Json.OdvMonitor.MsgListenerCtrlRefresh().
|
private |
Referenced by com.UniPRT.Sdk.Json.OdvMonitor.OdvMonitor().
|
private |
Referenced by com.UniPRT.Sdk.Json.OdvMonitor.Dispose(), and com.UniPRT.Sdk.Json.OdvMonitor.OdvMonitor().
|
staticprivate |
Referenced by com.UniPRT.Sdk.Json.OdvMonitor.MsgListenerCtrlRefresh().
|
staticprivate |
Referenced by com.UniPRT.Sdk.Json.OdvMonitor.MsgListenerCtrlRefresh().
|
private |