AmiStatus Class

Class

Declaration

class AmiStatus;

Purpose

Objects of this class also are used to return an error condition to the monitoring TIBCO Hawk agent.

Member Summary

 

Member

Purpose

Page

AmiStatus()

Constructor

AmiStatus()

operator ami_Error() const

Operator to convert an

ami_Error to AmiStatus.

AmiStatus& operator=(const AmiStatus& status)

Assignment operator.

AmiStatus& operator=(const ami_Error status)

Assignment operator.

AmiStatus& operator=(const ami_ErrorCode errorCode)

Assignment operator.

ami_Boolean operator==(const AmiStatus& status)

Comparison operator.

ami_Boolean operator!=(const AmiStatus& status)

Comparison operator.

ami_Boolean operator==(const ami_Error status)

Comparison operator.

ami_Boolean operator!=(const ami_Error status)

Comparison operator.

ami_Boolean operator!() const

Comparison operator.

ami_Boolean ok(void) const

Evaluates whether this status object— indicates an error state.

AmiStatus::getAmiError()

Returns the C API error handle of this AmiStatus object.

AmiStatus::getAmiError()

AmiStatus::setStatus()

Creates a new AMI error for the specified error code and descriptive text.

AmiStatus::setStatus()

AmiStatus::setStatusV()

AmiStatus::setStatusV()

AmiStatus::stamp()

Stamps AMI error for location ID

AmiStatus::stamp()

AmiStatus::getCode()

returns the AMI C API error code

AmiStatus::getCode()

AmiStatus::getText()

Returns the textual description of the error

AmiStatus::getText()

AmiStatus::getThread()

Returns the thread ID of the thread which created the specified AMI error

AmiStatus::getThread()

AmiStatus::getFile()

Returns error’s source file name

AmiStatus::getFile()

AmiStatus::getLine()

Returns the line number of the error source

AmiStatus::getLine()