IRISLIB database
Tracer Class Reference

This class allows tracing to performed of the calls made within the paho-c library. More...

Inheritance diagram for Tracer:
Collaboration diagram for Tracer:

Public Member Functions

 Log (_.Library.Integer level, _.Library.String message)
 Minimal implementation, normally would delegate.
 
_.Library.Status LoggerSet (_.Net.MQTT.Logger logger)
 Property setter, attach a delegate.
 
_.Library.Status Start ()
 Start tracing.
 
_.Library.Status Stop ()
 Stop tracing.
 
_.Library.Status TraceLevelSet (_.Library.Integer level)
 Set the trace level (see Net.MQTT.inc for appropriate values)
 
- Public Member Functions inherited from RegisteredObject
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
 
_.Library.Status OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
 This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 

Public Attributes

 Logger
 Logger delegate, initially is self. More...
 
 TraceLevel
 This is the trace level required. More...
 

Static Public Attributes

 DOMAIN = None
 This class allows tracing to performed of the calls made within the paho-c library. More...
 
- Static Public Attributes inherited from RegisteredObject
 CAPTION = None
 Optional name used by the Form Wizard for a class when generating forms. More...
 
 JAVATYPE = None
 The Java type to be used when exported.
 
 PROPERTYVALIDATION = None
 This parameter controls the default validation behavior for the object. More...
 

Private Member Functions

_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status __DecodeError (_.Library.String list)
 Private, Decode an error reported by the library and form status.
 

Detailed Description

This class allows tracing to performed of the calls made within the paho-c library.

One instantiates an instance of the tracer and attaches an instance of Net.MQTT.Logger by setting the Logger property. The Tracer class then delegates log requests to the Logger class. If you don't provide a Logger instance then the default implementation uses this class (which is itself a logger) to perform the logging with a default implementation that just writes to the console.

Member Function Documentation

◆ OnNew()

_.Library.Status OnNew ( )
private

This callback method is invoked by the <METHOD>New</METHOD> method to.

provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from New(). For example, if you're going to call New, passing 2 arguments, OnNew's signature could be:

Method OnNew(dob as Date = "", name as Name = "") as Status If instead of returning a Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of New method.

Reimplemented from RegisteredObject.

Member Data Documentation

◆ DOMAIN

DOMAIN = None
static

This class allows tracing to performed of the calls made within the paho-c library.

One instantiates an instance of the tracer and attaches an instance of Net.MQTT.Logger by setting the Logger property. The Tracer class then delegates log requests to the Logger class. If you don't provide a Logger instance then the default implementation uses this class (which is itself a logger) to perform the logging with a default implementation that just writes to the console.

Error Text Domain

◆ Logger

Logger delegate, initially is self.

 

◆ TraceLevel

TraceLevel

This is the trace level required.