AmiSession Class

Class

Declaration

class AmiSession;

Purpose

An instance of AmiSession represents an interface to the TIBCO Hawk agent and is treated as a microagent.

Remarks

This class can be used as a base class for an application-specific AMI class. The user can inherit from this class and populate the AMI session with methods in the constructor.

The AmiSession class will establish point-to-point communication with a TIBCO Hawk agent.

Member Summary

 

Member

Description

Page

AmiSession()

Constructor. Independent of the transport being used.

AmiSession Class

AmiSession()

Constructor.

AmiSession Class

AmiSession::open()

Initializes the AMI API

AmiSession::open()

AmiSession::close()

Terminates the AMI API

AmiSession::close()

AmiSession::versionName()

Returns current version name

AmiSession::versionName()

AmiSession::version()

Returns current version

AmiSession::version()

AmiSession::versionDate()

Returns current version date

AmiSession::versionDate()

AmiSession::banner()

Returns product banner

AmiSession::banner()

AmiSession::versionMajor()

Returns major version

AmiSession::versionMajor()

AmiSession::versionMinor()

returns minor version

AmiSession::versionMinor()

AmiSession::getTraceLevels()

Returns the current AMI session trace level settings

AmiSession::getTraceLevels()

AmiSession::setTraceLevels()

Resets AMI session trace level settings

AmiSession::setTraceLevels()

AmiSession::enableTraceLevels()

Enables levels of race output.

AmiSession::enableTraceLevels()

AmiSession::disableTraceLevels()

Disables levels of trace output

AmiSession::disableTraceLevels()

AmiSession::announce()

Announces existence of the microagent.

AmiSession::announce()

AmiSession::get... Accessors()

Returns AmiSession accessors.

AmiSession::get... Accessors

AmiSession::sendUnsolicitedMsg()

Sends unsolicited message to the monitoring agent.

AmiSession::sendUnsolicitedMsg()

AmiSession::stop()

Stops the AMI session

AmiSession::stop()