AmiSession()

Constructor

Declaration

AmiSession(ami_TraceCode traceLevel, 
           AmiProperty amiProperty, 
           const char * name, 
           const char * display, 
           const char * help, 
           ami_TraceHandler traceHandler,
           const void * userData ); 

Purpose

This constructor creates an instance of AmiSession. Each instance corresponds to an independent microagent.

Parameters

 

Parameter

Description

traceLevel

AMI trace levels for this AMI session. Levels can be:

AMI_ALL. Turns on all trace code levels.

AMI_AMI. Indicates AMI level trace message.

AMI_DEBUG. Logging statement are written into the trace file if, and only if, the trace level set in the current ami_Session object has the AMI_DEBUG bit mask turned on.

AMI_ERROR. Logging statement are written into the trace file, regardless of whether the AMI_ERROR bit mask is turned on in the current ami_Session object.

AMI_INFO. Logging statements are written into the trace file if, and only if, the trace level set in the current ami_Session object has the AMI_INFO bit mask turned on.

AMI_STAMP. Adds source file name and line number to all messages.

AMI_WARNING. Logging statement are written into the trace file if, and only if, the trace level set in the current ami_Session object has the AMI_WARNING bit mask turned on.

amiProperty

Object of AmiProperty Class class.

name

Internal name of the microagent.

display

User friendly name for the microagent. This name appears in the TIBCO Hawk Console.

help

Help text for describing the functions of this microagent.

traceHandler

Error callback function used for this AMI session.

userData

User data for this AMI session.