UniPRT SDK  v1.0.0.0
com.UniPRT.Sdk.Json.SettingsReadWrite Class Reference
Inheritance diagram for com.UniPRT.Sdk.Json.SettingsReadWrite:
com.UniPRT.Sdk.Json.ISettingsReadWrite

Public Member Functions

void Dispose ()
 
Map< String, String > GetAllValues ()
 Inherited from ISettingsReadWrite.GetAllValues. More...
 
String GetValue (String key)
 Inherited from ISettingsReadWrite.GetValue. More...
 
Map< String, String > GetValues (List< String > keys)
 Inherited from ISettingsReadWrite.GetValues. More...
 
boolean SetValue (String keyToSet, String valueToSet)
 Inherited from ISettingsReadWrite.SetValue. More...
 
boolean SetValues (Map< String, String > keysToSet)
 Inherited from ISettingsReadWrite.SetValues. More...
 
Setting GetProperties (String key)
 Inherited from ISettingsReadWrite.GetProperties. More...
 
Map< String, SettingGetProperties (List< String > keys)
 Inherited from ISettingsReadWrite.GetProperties. More...
 
Map< String, SettingGetAllProperties ()
 Inherited from ISettingsReadWrite.GetAllProperties. More...
 
 SettingsReadWrite (IComm connection)
 Must pass an opened comm connection that can remain opened if listening for unsolicited msgs from printer. More...
 
 SettingsReadWrite (JsonComm mgmtComm)
 Constructor called when an mgmt comm object already exists for listening for mgmt msgs. More...
 
 SettingsReadWrite (String commDescriptor)
 Constructor called when creating a connection managed by the SDK. More...
 
void close () throws Exception
 

Protected Member Functions

void Dispose (boolean disposing)
 
void finalize () throws Throwable
 

Private Attributes

IComm _PtrComm
 
JsonComm _MgmtComm
 
boolean _sdkManagedComm = false
 
String _managedDescriptor = ""
 
boolean _disposed = false
 

Static Private Attributes

static final String CMD_ITEM = "Cfg.Item"
 
static final String CMD_PROP = "Cfg.Prop"
 
static ObjectMapper mapper = new ObjectMapper()
 

Constructor & Destructor Documentation

◆ SettingsReadWrite() [1/3]

com.UniPRT.Sdk.Json.SettingsReadWrite.SettingsReadWrite ( IComm  connection)

Must pass an opened comm connection that can remain opened if listening for unsolicited msgs from printer.

A connection is necessary to send/receive printer status msgs.

References com.UniPRT.Sdk.Json.SettingsReadWrite._MgmtComm, and com.UniPRT.Sdk.Json.SettingsReadWrite._PtrComm.

◆ SettingsReadWrite() [2/3]

com.UniPRT.Sdk.Json.SettingsReadWrite.SettingsReadWrite ( 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.SettingsReadWrite._MgmtComm.

◆ SettingsReadWrite() [3/3]

com.UniPRT.Sdk.Json.SettingsReadWrite.SettingsReadWrite ( 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.SettingsReadWrite._managedDescriptor, com.UniPRT.Sdk.Json.SettingsReadWrite._MgmtComm, com.UniPRT.Sdk.Json.SettingsReadWrite._sdkManagedComm, com.UniPRT.Sdk.Json.JsonCommController.CreateMgmtComm(), and com.UniPRT.Sdk.Json.JsonCommController.Instance().

Member Function Documentation

◆ close()

void com.UniPRT.Sdk.Json.SettingsReadWrite.close ( ) throws Exception

◆ Dispose() [1/2]

void com.UniPRT.Sdk.Json.SettingsReadWrite.Dispose ( )

◆ Dispose() [2/2]

◆ finalize()

void com.UniPRT.Sdk.Json.SettingsReadWrite.finalize ( ) throws Throwable
protected

◆ GetAllProperties()

◆ GetAllValues()

◆ GetProperties() [1/2]

◆ GetProperties() [2/2]

◆ GetValue()

◆ GetValues()

◆ SetValue()

◆ SetValues()

Member Data Documentation

◆ _disposed

boolean com.UniPRT.Sdk.Json.SettingsReadWrite._disposed = false
private

◆ _managedDescriptor

String com.UniPRT.Sdk.Json.SettingsReadWrite._managedDescriptor = ""
private

◆ _MgmtComm

◆ _PtrComm

IComm com.UniPRT.Sdk.Json.SettingsReadWrite._PtrComm
private

◆ _sdkManagedComm

boolean com.UniPRT.Sdk.Json.SettingsReadWrite._sdkManagedComm = false
private

◆ CMD_ITEM

◆ CMD_PROP

final String com.UniPRT.Sdk.Json.SettingsReadWrite.CMD_PROP = "Cfg.Prop"
staticprivate

◆ mapper

ObjectMapper com.UniPRT.Sdk.Json.SettingsReadWrite.mapper = new ObjectMapper()
staticprivate

The documentation for this class was generated from the following file: