UniPRT SDK  v1.0.0.0
com.UniPRT.Sdk.Settings.Configs Class Reference

Support for reading and writing printer configurations. More...

Inheritance diagram for com.UniPRT.Sdk.Settings.Configs:
com.UniPRT.Sdk.Settings.IConfigs

Public Member Functions

List< ConfigGetAllConfig ()
 Inherited from IConfigs.GetAllConfig. More...
 
Config GetConfig (int cfgNumber)
 Inherited from IConfigs.GetConfig. More...
 
boolean SetConfig (Config Cfg)
 Inherited from IConfigs.SetConfig
More...
 
 Configs (IComm connection)
 Must pass an opened comm connection that can remain opened if listening for unsolicited msgs from printer. More...
 
 Configs (JsonComm mgmtComm)
 Constructor called when a mgmt comm object already exists for listening for mgmt msgs. More...
 
 Configs (String commDescriptor)
 Constructor called when creating a connection managed by the SDK. More...
 
void Dispose ()
 
void close ()
 

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_READ = "Cfg.Upload"
 
static final String CMD_WRITE = "Cfg.Download"
 
static final int CFG_INDEX_FACTORY = 0
 
static final int CFG_INDEX_MAX = 8
 

Detailed Description

Support for reading and writing printer configurations.

Examples


Constructor & Destructor Documentation

◆ Configs() [1/3]

com.UniPRT.Sdk.Settings.Configs.Configs ( 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.Settings.Configs._MgmtComm, and com.UniPRT.Sdk.Settings.Configs._PtrComm.

◆ Configs() [2/3]

com.UniPRT.Sdk.Settings.Configs.Configs ( JsonComm  mgmtComm)

Constructor called when a mgmt comm object already exists for listening for mgmt msgs.

Todo:
ToDo: Raul Update!
  • Can this constructor be temporarily removed if internal management of JsonComm objects is done?
  • e.g., use "Singleton" design pattern to create "instance" that is shared between all service consumers
  • That is, can internal management of JsonComm objects be implemented since there can only be one JsonComm object per printer that is listening and parsing fully formed mgmt msgs and forwarding to all mgmt msg listeners.

References com.UniPRT.Sdk.Settings.Configs._MgmtComm.

◆ Configs() [3/3]

com.UniPRT.Sdk.Settings.Configs.Configs ( String  commDescriptor)

Constructor called when creating a connection managed by the SDK.

commDescriptor is the descriptor for the communication used to connect with the printer.
TCP descriptor format: "ip" or "ip:port"
e.g., "127.0.0.1" or "127.0.0.1:3007"
If the port is not provided, the default value is used.

References com.UniPRT.Sdk.Settings.Configs._managedDescriptor, com.UniPRT.Sdk.Settings.Configs._MgmtComm, com.UniPRT.Sdk.Settings.Configs._sdkManagedComm, com.UniPRT.Sdk.Json.JsonCommController.CreateMgmtComm(), and com.UniPRT.Sdk.Json.JsonCommController.Instance().

Member Function Documentation

◆ close()

void com.UniPRT.Sdk.Settings.Configs.close ( )

◆ Dispose() [1/2]

void com.UniPRT.Sdk.Settings.Configs.Dispose ( )

◆ Dispose() [2/2]

◆ finalize()

void com.UniPRT.Sdk.Settings.Configs.finalize ( ) throws Throwable
protected

◆ GetAllConfig()

◆ GetConfig()

◆ SetConfig()

Member Data Documentation

◆ _disposed

boolean com.UniPRT.Sdk.Settings.Configs._disposed = false
private

◆ _managedDescriptor

String com.UniPRT.Sdk.Settings.Configs._managedDescriptor = ""
private

◆ _MgmtComm

◆ _PtrComm

IComm com.UniPRT.Sdk.Settings.Configs._PtrComm
private

◆ _sdkManagedComm

boolean com.UniPRT.Sdk.Settings.Configs._sdkManagedComm = false
private

◆ CFG_INDEX_FACTORY

final int com.UniPRT.Sdk.Settings.Configs.CFG_INDEX_FACTORY = 0
staticprivate

◆ CFG_INDEX_MAX

final int com.UniPRT.Sdk.Settings.Configs.CFG_INDEX_MAX = 8
staticprivate

◆ CMD_READ

final String com.UniPRT.Sdk.Settings.Configs.CMD_READ = "Cfg.Upload"
staticprivate

◆ CMD_WRITE

final String com.UniPRT.Sdk.Settings.Configs.CMD_WRITE = "Cfg.Download"
staticprivate

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