OdvMonitor.OdvMonitor Class Reference

Public Member Functions
	__init__ (self, connection=None, mgmt_comm=None, comm_descriptor=None)
	init_with_tcp_comm (self, connection)
	Initializes a new instance with the given TCP communication object.
	init_with_json_comm (self, mgmt_comm)
	Initializes a new instance with the given JSON communication object.
	init_with_comm_descriptor (self, comm_descriptor)
	Constructor called when creating a connection managed by the SDK.
	set_odv_report_listening (self, value)
	Sets whether ODV report listening is enabled.
	stop_listening_thread (self)
	Stop the listening thread.

Public Attributes
	ptr_comm = connection
	mgmt_comm = JsonComm(connection, CommType.TCP_COMM)
	my_mgmt_id = JsonStringBuilder.get_random_object_id_json()
	sync_context
bool	sdk_managed_comm = True
	managed_descriptor = comm_descriptor
	odv_report_listening = value
	listener_cts
	listener_thread

Constructor & Destructor Documentation

__init__()

OdvMonitor.OdvMonitor.__init__	(		self,
			connection = None,
			mgmt_comm = None,
			comm_descriptor = None )

Member Function Documentation

init_with_comm_descriptor()

OdvMonitor.OdvMonitor.init_with_comm_descriptor	(		self,
			comm_descriptor )

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.

Parameters

comm_descriptor

The communication descriptor.

Returns

An initialized instance of OdvMonitor, or nil if the object could not be created.

init_with_json_comm()

OdvMonitor.OdvMonitor.init_with_json_comm	(		self,
			mgmt_comm )

Initializes a new instance with the given JSON communication object.

Parameters

mgmt_comm

The JSON communication object.

Returns

An initialized instance of OdvMonitor, or nil if the object could not be created.

init_with_tcp_comm()

OdvMonitor.OdvMonitor.init_with_tcp_comm	(		self,
			connection )

Initializes a new instance with the given TCP communication object.

Parameters

connection

The TCP communication object.

Returns

An initialized instance of OdvMonitor, or nil if the object could not be created.

set_odv_report_listening()

OdvMonitor.OdvMonitor.set_odv_report_listening	(		self,
			value )

Sets whether ODV report listening is enabled.

Parameters

value

YES to enable listening, NO to disable.

stop_listening_thread()

OdvMonitor.OdvMonitor.stop_listening_thread

(

self

)

Stop the listening thread.

Member Data Documentation

listener_cts

OdvMonitor.OdvMonitor.listener_cts

listener_thread

OdvMonitor.OdvMonitor.listener_thread

managed_descriptor

OdvMonitor.OdvMonitor.managed_descriptor = comm_descriptor

mgmt_comm

OdvMonitor.OdvMonitor.mgmt_comm = JsonComm(connection, CommType.TCP_COMM)

my_mgmt_id

OdvMonitor.OdvMonitor.my_mgmt_id = JsonStringBuilder.get_random_object_id_json()

odv_report_listening

OdvMonitor.OdvMonitor.odv_report_listening = value

ptr_comm

OdvMonitor.OdvMonitor.ptr_comm = connection

sdk_managed_comm

bool OdvMonitor.OdvMonitor.sdk_managed_comm = True

sync_context

OdvMonitor.OdvMonitor.sync_context

---

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

• /Users/bob_huang/Documents/Project/UniPRTSDK_python/Json/OdvMonitor.py