Copyright © Cloud Software Group, Inc. All Rights Reserved

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.	78
AmiSession()	Constructor.	78
AmiSession::open()	Initializes the AMI API	84
AmiSession::close()	Terminates the AMI API	85
AmiSession::versionName()	Returns current version name	86
AmiSession::version()	Returns current version	87
AmiSession::versionDate()	Returns current version date	88
AmiSession::banner()	Returns product banner	89
AmiSession::versionMajor()	Returns major version	90
AmiSession::versionMinor()	returns minor version	91
AmiSession::getTraceLevels()	Returns the current AMI session trace level settings	92
AmiSession::setTraceLevels()	Resets AMI session trace level settings	93
AmiSession::enableTraceLevels()	Enables levels of race output.	94
AmiSession::disableTraceLevels()	Disables levels of trace output	95
AmiSession::announce()	Announces existence of the microagent.	96
AmiSession::get... Accessors()	Returns AmiSession accessors.	97
AmiSession::sendUnsolicitedMsg()	Sends unsolicited message to the monitoring agent.	98
AmiSession::stop()	Stops the AMI session	99

Copyright © Cloud Software Group, Inc. All Rights Reserved