Module to facilitate listening/retrieval of printer unsolicited messaging or retrieval of printer status/information. More...
Public Member Functions | |
AlertStatusNotice | GetAlertStatusCallback () |
void | SetAlertStatusCallback (AlertStatusNotice callback) |
Holds the function to call when fault/alert msgs received from printer. Function must match signature of AlertStatusNotice. More... | |
DisplayStatusNotice | GetDisplayStatusCallback () |
void | SetDisplayStatusCallback (DisplayStatusNotice callback) |
Holds the function to call when display text msgs received from printer. Function must match signature of DisplayStatusNotice. More... | |
EngineStatusNotice | GetEngineStatusCallback () |
void | SetEngineStatusCallback (EngineStatusNotice callback) |
Holds the function to call when engine status received from printer. Function must match signature of EngineStatusNotice. More... | |
boolean | GetAlertStatusListening () |
Inherited from IPrinterMonitor.AlertStatusListening. More... | |
void | SetAlertStatusListening (boolean listening) |
Enable/disable listening/parsing unsolicited fault status alerts from printer. More... | |
boolean | GetDisplayStatusListening () |
Inherited from IPrinterMonitor.DisplayStatusListening. More... | |
void | SetDisplayStatusListening (boolean listening) |
Enable/disable listening/parsing unsolicited front panel display text from printer. More... | |
boolean | GetEngineStatusListening () |
Inherited from IPrinterMonitor.EngineStatusListening. More... | |
void | SetEngineStatusListening (boolean listening) |
Enable/disable listening/parsing unsolicited engine status from printer. More... | |
PrinterMonitor (TcpConnection connection) | |
PrinterMonitor (JsonComm mgmtComm) | |
PrinterMonitor (String commDescriptor) | |
PrinterInfo | GetPrinterInfo () |
Inherited from IPrinterMonitor.GetPrinterInfo More... | |
String | GetEngineStatus () |
Inherited from IPrinterMonitor.GetEngineStatus More... | |
String[] | GetFaultStatus () |
Inherited from IPrinterMonitor.GetFaultStatus More... | |
void | Dispose () |
void | close () throws Exception |
Protected Member Functions | |
void | Dispose (boolean disposing) |
void | finalize () throws Throwable |
Private Member Functions | |
void | triggerCallbackForOdvReport (String[] alert) |
void | DisplayStatus (String[] newDisplayText) |
void | triggerCallbackForEngineStatus (String engineState) |
void | MsgListenerCtrlRefresh () |
void | CallbackForAlertStatus (String[] alertText) |
void | CallbackForDisplayStatus (String[] panelText) |
void | CallbackForEngineStatus (String newEngineState) |
Map< String, String > | MsgParser_PrinterInfo (String mgmtReportFrame) |
Private Attributes | |
TcpConnection | _ptrComm |
JsonComm | _mgmtComm |
Channel< String > | _msgsFromPtr |
String | _myMgmtId = "" |
AtomicBoolean | _mgmtMsgListening = new AtomicBoolean(false) |
AtomicBoolean | _alertStatusListening = new AtomicBoolean(false) |
AtomicBoolean | _displayStatusListening = new AtomicBoolean(false) |
AtomicBoolean | _engineStatusListening = new AtomicBoolean(false) |
ExecutorService | _executor = Executors.newSingleThreadExecutor() |
Future<?> | _listenerTask |
ConcurrentLinkedQueue< String > | _mgmtFilteredMsgs = new ConcurrentLinkedQueue<>() |
AlertStatusNotice | AlertStatusCallback |
Inherited from IPrinterMonitor.AlertStatusCallback. More... | |
DisplayStatusNotice | DisplayStatusCallback |
Inherited from IPrinterMonitor.DisplayStatusCallback. More... | |
EngineStatusNotice | EngineStatusCallback |
Inherited from IPrinterMonitor.EngineStatusCallback. More... | |
String[] | displayText = new String[] { "", "" } |
String[] | alertText = new String[] { "", "" } |
boolean | _sdkManagedComm = false |
String | _managedDescriptor = "" |
boolean | _disposed = false |
Map< Integer, String > | alertLUT |
Static Private Attributes | |
static final int | MAX_MSGS_FROM_PTR = 100 |
static final int | MAX_ODV_MSGS = 2 |
Module to facilitate listening/retrieval of printer unsolicited messaging or retrieval of printer status/information.
Unsolicited messages, if enabled on printer, can be sent at any time. This module requires a constant connection to the printer's management port in order to listen for any messaging sent out by printer.
Result after causing fault by opening/closing print head, and pressing the pause button on printer to place printer "offline"/"online".
com.UniPRT.Sdk.Json.PrinterMonitor.PrinterMonitor | ( | TcpConnection | connection | ) |
References com.UniPRT.Sdk.Json.PrinterMonitor._mgmtComm, com.UniPRT.Sdk.Json.PrinterMonitor._myMgmtId, com.UniPRT.Sdk.Json.PrinterMonitor._ptrComm, com.UniPRT.Sdk.Json.PrinterMonitor.AlertStatusCallback, com.UniPRT.Sdk.Json.PrinterMonitor.DisplayStatusCallback, com.UniPRT.Sdk.Json.PrinterMonitor.EngineStatusCallback, and com.UniPRT.Sdk.Json.JsonStringBuilder.GetRandomObjectId_Json().
com.UniPRT.Sdk.Json.PrinterMonitor.PrinterMonitor | ( | JsonComm | mgmtComm | ) |
References com.UniPRT.Sdk.Json.PrinterMonitor._mgmtComm, com.UniPRT.Sdk.Json.PrinterMonitor._myMgmtId, com.UniPRT.Sdk.Json.PrinterMonitor.AlertStatusCallback, com.UniPRT.Sdk.Json.PrinterMonitor.DisplayStatusCallback, com.UniPRT.Sdk.Json.PrinterMonitor.EngineStatusCallback, and com.UniPRT.Sdk.Json.JsonStringBuilder.GetRandomObjectId_Json().
com.UniPRT.Sdk.Json.PrinterMonitor.PrinterMonitor | ( | String | commDescriptor | ) |
References com.UniPRT.Sdk.Json.PrinterMonitor._managedDescriptor, com.UniPRT.Sdk.Json.PrinterMonitor._mgmtComm, com.UniPRT.Sdk.Json.PrinterMonitor._myMgmtId, com.UniPRT.Sdk.Json.PrinterMonitor._sdkManagedComm, com.UniPRT.Sdk.Json.PrinterMonitor.AlertStatusCallback, com.UniPRT.Sdk.Json.JsonCommController.CreateMgmtComm(), com.UniPRT.Sdk.Json.PrinterMonitor.DisplayStatusCallback, com.UniPRT.Sdk.Json.PrinterMonitor.EngineStatusCallback, com.UniPRT.Sdk.Json.JsonStringBuilder.GetRandomObjectId_Json(), and com.UniPRT.Sdk.Json.JsonCommController.Instance().
|
private |
|
private |
|
private |
void com.UniPRT.Sdk.Json.PrinterMonitor.close | ( | ) | throws Exception |
References com.UniPRT.Sdk.Json.PrinterMonitor.Dispose().
Referenced by com.UniPRT.Sdk.Json.PrinterMonitor.finalize().
|
private |
void com.UniPRT.Sdk.Json.PrinterMonitor.Dispose | ( | ) |
Referenced by com.UniPRT.Sdk.Json.PrinterMonitor.close().
|
protected |
References com.UniPRT.Sdk.Json.PrinterMonitor._disposed, com.UniPRT.Sdk.Json.PrinterMonitor._listenerTask, com.UniPRT.Sdk.Json.PrinterMonitor._managedDescriptor, com.UniPRT.Sdk.Json.PrinterMonitor._sdkManagedComm, com.UniPRT.Sdk.Json.JsonCommController.Instance(), and com.UniPRT.Sdk.Json.JsonCommController.ReleaseMgmtComm().
|
protected |
AlertStatusNotice com.UniPRT.Sdk.Json.PrinterMonitor.GetAlertStatusCallback | ( | ) |
Implements com.UniPRT.Sdk.Json.IPrinterMonitor.
References com.UniPRT.Sdk.Json.PrinterMonitor.AlertStatusCallback.
boolean com.UniPRT.Sdk.Json.PrinterMonitor.GetAlertStatusListening | ( | ) |
Inherited from IPrinterMonitor.AlertStatusListening.
Implements com.UniPRT.Sdk.Json.IPrinterMonitor.
References com.UniPRT.Sdk.Json.PrinterMonitor._alertStatusListening.
DisplayStatusNotice com.UniPRT.Sdk.Json.PrinterMonitor.GetDisplayStatusCallback | ( | ) |
Implements com.UniPRT.Sdk.Json.IPrinterMonitor.
References com.UniPRT.Sdk.Json.PrinterMonitor.DisplayStatusCallback.
boolean com.UniPRT.Sdk.Json.PrinterMonitor.GetDisplayStatusListening | ( | ) |
Inherited from IPrinterMonitor.DisplayStatusListening.
Implements com.UniPRT.Sdk.Json.IPrinterMonitor.
References com.UniPRT.Sdk.Json.PrinterMonitor._displayStatusListening.
String com.UniPRT.Sdk.Json.PrinterMonitor.GetEngineStatus | ( | ) |
Inherited from IPrinterMonitor.GetEngineStatus
Implements com.UniPRT.Sdk.Json.IPrinterMonitor.
References com.UniPRT.Sdk.Json.PrinterMonitor._mgmtComm, com.UniPRT.Sdk.Json.JsonStringBuilder.CreateMsgFrame_Json(), com.UniPRT.Sdk.Json.JsonStringTokenizer.GetKeyValueAtPath(), com.UniPRT.Sdk.Json.JsonStringBuilder.GetRandomId_Json(), and com.UniPRT.Sdk.Json.JsonComm.SendAndWaitForResponse().
EngineStatusNotice com.UniPRT.Sdk.Json.PrinterMonitor.GetEngineStatusCallback | ( | ) |
Implements com.UniPRT.Sdk.Json.IPrinterMonitor.
References com.UniPRT.Sdk.Json.PrinterMonitor.EngineStatusCallback.
boolean com.UniPRT.Sdk.Json.PrinterMonitor.GetEngineStatusListening | ( | ) |
Inherited from IPrinterMonitor.EngineStatusListening.
Implements com.UniPRT.Sdk.Json.IPrinterMonitor.
References com.UniPRT.Sdk.Json.PrinterMonitor._engineStatusListening.
String [] com.UniPRT.Sdk.Json.PrinterMonitor.GetFaultStatus | ( | ) |
Inherited from IPrinterMonitor.GetFaultStatus
Implements com.UniPRT.Sdk.Json.IPrinterMonitor.
References com.UniPRT.Sdk.Json.PrinterMonitor._mgmtComm, com.UniPRT.Sdk.Json.PrinterMonitor.alertLUT, com.UniPRT.Sdk.Json.PrinterMonitor.alertText, com.UniPRT.Sdk.Json.JsonStringBuilder.CreateMsgFrame_Json(), com.UniPRT.Sdk.Json.JsonStringTokenizer.GetKeyValueAtPath(), com.UniPRT.Sdk.Json.JsonStringBuilder.GetRandomId_Json(), and com.UniPRT.Sdk.Json.JsonComm.SendAndWaitForResponse().
PrinterInfo com.UniPRT.Sdk.Json.PrinterMonitor.GetPrinterInfo | ( | ) |
Inherited from IPrinterMonitor.GetPrinterInfo
Implements com.UniPRT.Sdk.Json.IPrinterMonitor.
References com.UniPRT.Sdk.Json.PrinterMonitor._mgmtComm, com.UniPRT.Sdk.Json.JsonStringBuilder.CreateMsgFrame_Json(), com.UniPRT.Sdk.Json.JsonStringBuilder.GetRandomId_Json(), com.UniPRT.Sdk.Json.PrinterMonitor.MsgParser_PrinterInfo(), com.UniPRT.Sdk.Json.JsonComm.SendAndWaitForResponse(), and com.UniPRT.Sdk.Json.PrinterInfo.SetRawInfo().
|
private |
References com.UniPRT.Sdk.Json.PrinterMonitor._alertStatusListening, com.UniPRT.Sdk.Json.PrinterMonitor._displayStatusListening, com.UniPRT.Sdk.Json.PrinterMonitor._engineStatusListening, com.UniPRT.Sdk.Json.PrinterMonitor._executor, com.UniPRT.Sdk.Json.PrinterMonitor._listenerTask, com.UniPRT.Sdk.Json.PrinterMonitor._mgmtComm, com.UniPRT.Sdk.Json.PrinterMonitor._mgmtFilteredMsgs, com.UniPRT.Sdk.Json.PrinterMonitor._mgmtMsgListening, com.UniPRT.Sdk.Json.PrinterMonitor._msgsFromPtr, com.UniPRT.Sdk.Json.PrinterMonitor.alertLUT, com.UniPRT.Sdk.Json.PrinterMonitor.AlertStatusCallback, com.UniPRT.Sdk.Json.PrinterMonitor.alertText, com.UniPRT.Sdk.Json.JsonComm.ChannelListenerJson(), com.UniPRT.Sdk.Json.PrinterMonitor.DisplayStatusCallback, com.UniPRT.Sdk.Json.PrinterMonitor.displayText, com.UniPRT.Sdk.Json.PrinterMonitor.EngineStatusCallback, com.UniPRT.Sdk.Json.JsonStringTokenizer.GetKeyValue(), com.UniPRT.Sdk.Json.JsonStringTokenizer.GetKeyValueAtPath(), com.UniPRT.Sdk.Json.JsonStringTokenizer.GetMsgId_Json(), com.UniPRT.Sdk.Json.EngineStatusNotice.handle(), com.UniPRT.Sdk.Json.DisplayStatusNotice.handle(), com.UniPRT.Sdk.Json.AlertStatusNotice.handle(), com.UniPRT.Sdk.Json.JsonStringTokenizer.HasKeyAtPath(), com.UniPRT.Sdk.Json.PrinterMonitor.MAX_MSGS_FROM_PTR, com.UniPRT.Sdk.Json.PrinterMonitor.MAX_ODV_MSGS, com.UniPRT.Sdk.Mgmt.Channel< T >.Take(), and com.UniPRT.Sdk.Mgmt.MgmtChannelFilterType.UNSOLICITED_MSGS_ONLY.
Referenced by com.UniPRT.Sdk.Json.PrinterMonitor.SetAlertStatusListening(), com.UniPRT.Sdk.Json.PrinterMonitor.SetDisplayStatusListening(), and com.UniPRT.Sdk.Json.PrinterMonitor.SetEngineStatusListening().
|
private |
void com.UniPRT.Sdk.Json.PrinterMonitor.SetAlertStatusCallback | ( | AlertStatusNotice | callback | ) |
Holds the function to call when fault/alert msgs received from printer. Function must match signature of AlertStatusNotice.
Implements com.UniPRT.Sdk.Json.IPrinterMonitor.
void com.UniPRT.Sdk.Json.PrinterMonitor.SetAlertStatusListening | ( | boolean | listening | ) |
Enable/disable listening/parsing unsolicited fault status alerts from printer.
Note that this must be enabled in order to receive any notifications, AlertStatusCallback, from printer.
Implements com.UniPRT.Sdk.Json.IPrinterMonitor.
References com.UniPRT.Sdk.Json.PrinterMonitor._alertStatusListening, com.UniPRT.Sdk.Json.PrinterMonitor._mgmtComm, com.UniPRT.Sdk.Json.PrinterMonitor._myMgmtId, com.UniPRT.Sdk.Json.JsonStringBuilder.CreateMsgFrame_Json(), com.UniPRT.Sdk.Json.PrinterMonitor.MsgListenerCtrlRefresh(), and com.UniPRT.Sdk.Json.JsonComm.SendAndWaitForResponse().
void com.UniPRT.Sdk.Json.PrinterMonitor.SetDisplayStatusCallback | ( | DisplayStatusNotice | callback | ) |
Holds the function to call when display text msgs received from printer. Function must match signature of DisplayStatusNotice.
Implements com.UniPRT.Sdk.Json.IPrinterMonitor.
void com.UniPRT.Sdk.Json.PrinterMonitor.SetDisplayStatusListening | ( | boolean | listening | ) |
Enable/disable listening/parsing unsolicited front panel display text from printer.
Note that this must be enabled in order to receive any notifications, DisplayStatusCallback, from printer.
Implements com.UniPRT.Sdk.Json.IPrinterMonitor.
References com.UniPRT.Sdk.Json.PrinterMonitor._displayStatusListening, com.UniPRT.Sdk.Json.PrinterMonitor._mgmtComm, com.UniPRT.Sdk.Json.PrinterMonitor._myMgmtId, com.UniPRT.Sdk.Json.JsonStringBuilder.CreateMsgFrame_Json(), com.UniPRT.Sdk.Json.PrinterMonitor.MsgListenerCtrlRefresh(), and com.UniPRT.Sdk.Json.JsonComm.SendAndWaitForResponse().
void com.UniPRT.Sdk.Json.PrinterMonitor.SetEngineStatusCallback | ( | EngineStatusNotice | callback | ) |
Holds the function to call when engine status received from printer. Function must match signature of EngineStatusNotice.
Implements com.UniPRT.Sdk.Json.IPrinterMonitor.
void com.UniPRT.Sdk.Json.PrinterMonitor.SetEngineStatusListening | ( | boolean | listening | ) |
Enable/disable listening/parsing unsolicited engine status from printer.
Note that this must be enabled in order to receive any notifications, EngineStatusCallback, from printer.
Implements com.UniPRT.Sdk.Json.IPrinterMonitor.
References com.UniPRT.Sdk.Json.PrinterMonitor._engineStatusListening, com.UniPRT.Sdk.Json.PrinterMonitor._mgmtComm, com.UniPRT.Sdk.Json.PrinterMonitor._myMgmtId, com.UniPRT.Sdk.Json.JsonStringBuilder.CreateMsgFrame_Json(), com.UniPRT.Sdk.Json.PrinterMonitor.MsgListenerCtrlRefresh(), and com.UniPRT.Sdk.Json.JsonComm.SendAndWaitForResponse().
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
Referenced by com.UniPRT.Sdk.Json.PrinterMonitor.MsgListenerCtrlRefresh().
|
private |
|
private |
|
private |
Referenced by com.UniPRT.Sdk.Json.PrinterMonitor.GetEngineStatus(), com.UniPRT.Sdk.Json.PrinterMonitor.GetFaultStatus(), com.UniPRT.Sdk.Json.PrinterMonitor.GetPrinterInfo(), com.UniPRT.Sdk.Json.PrinterMonitor.MsgListenerCtrlRefresh(), com.UniPRT.Sdk.Json.PrinterMonitor.PrinterMonitor(), com.UniPRT.Sdk.Json.PrinterMonitor.SetAlertStatusListening(), com.UniPRT.Sdk.Json.PrinterMonitor.SetDisplayStatusListening(), and com.UniPRT.Sdk.Json.PrinterMonitor.SetEngineStatusListening().
|
private |
Referenced by com.UniPRT.Sdk.Json.PrinterMonitor.MsgListenerCtrlRefresh().
|
private |
Referenced by com.UniPRT.Sdk.Json.PrinterMonitor.MsgListenerCtrlRefresh().
|
private |
Referenced by com.UniPRT.Sdk.Json.PrinterMonitor.MsgListenerCtrlRefresh().
|
private |
|
private |
Referenced by com.UniPRT.Sdk.Json.PrinterMonitor.PrinterMonitor().
|
private |
|
private |
Referenced by com.UniPRT.Sdk.Json.PrinterMonitor.GetFaultStatus(), and com.UniPRT.Sdk.Json.PrinterMonitor.MsgListenerCtrlRefresh().
|
private |
Inherited from IPrinterMonitor.AlertStatusCallback.
Referenced by com.UniPRT.Sdk.Json.PrinterMonitor.CallbackForAlertStatus(), com.UniPRT.Sdk.Json.PrinterMonitor.GetAlertStatusCallback(), com.UniPRT.Sdk.Json.PrinterMonitor.MsgListenerCtrlRefresh(), com.UniPRT.Sdk.Json.PrinterMonitor.PrinterMonitor(), and com.UniPRT.Sdk.Json.PrinterMonitor.triggerCallbackForOdvReport().
|
private |
|
private |
Inherited from IPrinterMonitor.DisplayStatusCallback.
Referenced by com.UniPRT.Sdk.Json.PrinterMonitor.CallbackForDisplayStatus(), com.UniPRT.Sdk.Json.PrinterMonitor.DisplayStatus(), com.UniPRT.Sdk.Json.PrinterMonitor.GetDisplayStatusCallback(), com.UniPRT.Sdk.Json.PrinterMonitor.MsgListenerCtrlRefresh(), and com.UniPRT.Sdk.Json.PrinterMonitor.PrinterMonitor().
|
private |
Referenced by com.UniPRT.Sdk.Json.PrinterMonitor.MsgListenerCtrlRefresh().
|
private |
Inherited from IPrinterMonitor.EngineStatusCallback.
Referenced by com.UniPRT.Sdk.Json.PrinterMonitor.CallbackForEngineStatus(), com.UniPRT.Sdk.Json.PrinterMonitor.GetEngineStatusCallback(), com.UniPRT.Sdk.Json.PrinterMonitor.MsgListenerCtrlRefresh(), com.UniPRT.Sdk.Json.PrinterMonitor.PrinterMonitor(), and com.UniPRT.Sdk.Json.PrinterMonitor.triggerCallbackForEngineStatus().
|
staticprivate |
Referenced by com.UniPRT.Sdk.Json.PrinterMonitor.MsgListenerCtrlRefresh().
|
staticprivate |
Referenced by com.UniPRT.Sdk.Json.PrinterMonitor.MsgListenerCtrlRefresh().