AmiSyncMethod()

Copyright © Cloud Software Group, Inc. All Rights Reserved

Chapter 4 AMI API : AMI Method Classes : AmiSyncMethod()

AmiSyncMethod()

Constructor

Declaration

AmiSyncMethod(

   AmiSession * session,

   const char * name,

   const char * help,

   ami_MethodType type,

   int inTimeout);

Purpose

Constructs an instance of AmiSyncMethod class.

Parameters

Parameter

Description

session

AMI session object.

name

Name of the method.

help

Help text for the method.

type

Type of method. Must be one of AMI_METHOD_INFO, AMI_METHOD_ACTION or AMI_METHOD_ACTION_INFO.

AMI_METHOD_INFO methods collect data. Data sources in rulebases and method subscriptions in the TIBCO Hawk WebConsole use this type of method only.

AMI_METHOD_ACTION methods affect the application’s behavior in some way. They can be invoked in the TIBCO Hawk WebConsole through interacting with one agent or through a network action. Action methods can also be invoked as an action in a rulebase.

AMI_METHOD_ACTION_INFO methods both make a change to the application and return data. They can be invoked in the TIBCO Hawk WebConsole through interacting with one agent or through a network action.

inTimeout

The timeout interval of this AMI method. The default is 10000 milliseconds(10 seconds).

AmiSubscription Class

class

Declaration

class AmiSubscription;

Purpose

The AmiSubscription class encapsulates an asynchronous method subscription.

Member Summary

AmiSubscription::getUserData()

Allows retrieval of application specific data from a particular asynchronous method subscription

121

AmiSubscription::setCallbackInterval()

Indicates that for this subscription the associated AmiMethod::onInvoke() callback should be invoked automatically at the specific interval.

122

AmiSubscription::setUserData()

Allows attachment of application specific data to a particular asynchronous method subscription.

123

AmiSubscription::getMethod()

Allows retrieval of the associated AMI method object.

124

AmiSubscription::getArguments()

Allows retrieval of the method argument values for a particular asynchronous method subscription.

125

Parameter	Description
session	AMI session object.
name	Name of the method.
help	Help text for the method.
type	Type of method. Must be one of AMI_METHOD_INFO, AMI_METHOD_ACTION or AMI_METHOD_ACTION_INFO. AMI_METHOD_INFO methods collect data. Data sources in rulebases and method subscriptions in the TIBCO Hawk WebConsole use this type of method only. AMI_METHOD_ACTION methods affect the application’s behavior in some way. They can be invoked in the TIBCO Hawk WebConsole through interacting with one agent or through a network action. Action methods can also be invoked as an action in a rulebase. AMI_METHOD_ACTION_INFO methods both make a change to the application and return data. They can be invoked in the TIBCO Hawk WebConsole through interacting with one agent or through a network action.
inTimeout	The timeout interval of this AMI method. The default is 10000 milliseconds(10 seconds).


AmiSubscription::getUserData()	Allows retrieval of application specific data from a particular asynchronous method subscription	121
AmiSubscription::setCallbackInterval()	Indicates that for this subscription the associated AmiMethod::onInvoke() callback should be invoked automatically at the specific interval.	122
AmiSubscription::setUserData()	Allows attachment of application specific data to a particular asynchronous method subscription.	123
AmiSubscription::getMethod()	Allows retrieval of the associated AMI method object.	124
AmiSubscription::getArguments()	Allows retrieval of the method argument values for a particular asynchronous method subscription.	125