Class %Net.MQTT.Tracer

class %Net.MQTT.Tracer extends %Net.MQTT.Logger

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.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
1	2	8

Summary

Properties
Logger	TraceLevel

Methods
%AddToSaveSet	%ClassIsLatestVersion	%ClassName	%ConstructClone
%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty	%DispatchMethod
%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty	%Extends
%GetParameter	%IsA	%IsModified	%New
%NormalizeObject	%ObjectModified	%OnNew	%OriginalNamespace
%PackageName	%RemoveFromSaveSet	%SerializeObject	%SetModified
%ValidateObject	Log	LoggerSet	Start
Stop	TraceLevelSet

Parameters

• parameter DOMAIN = "%ObjectErrors";

Error Text Domain

Properties

• property Logger as %Net.MQTT.Logger [ InitialExpression = $this ];

Logger delegate, initially is self

• property TraceLevel as %Integer [ InitialExpression = $$$MQTTCLIENTTRACEFATAL ];

This is the trace level required

Methods

• method %OnNew() as %Status

This callback method is invoked by the %New 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.

• method Log(level As %Integer, message As %String)

Minimal implementation, normally would delegate

• method LoggerSet(logger As %Net.MQTT.Logger) as %Status

Property setter, attach a delegate

• method Start() as %Status

Start tracing

• method Stop() as %Status

Stop tracing

• method TraceLevelSet(level As %Integer) as %Status

Set the trace level (see %Net.MQTT.inc for appropriate values)

Class Reference IRIS for UNIX 2024.1.2
Documentation Search