Copyright © Cloud Software Group, Inc. All Rights Reserved

AMI C API Session Functions

This chapter describes the AMI C API session functions. Each AMI session manifests itself as a microagent in the associated AMI manager. The AMI C API session object (ami_Session) encapsulates an AMI session. The API provides handle-based functions to create, announce, stop, and destroy session objects.

•	Session Functions Summary

Session Functions Summary

This table summarizes the AMI C API session functions. These functions are described in the following sections.

Function	Description	Page
ami_SessionCreateUsingProperties()	Creates a new AMI session using transport properties.	197
ami_AddProperty()	Adds transport properties.	198
ami_SessionCreate()	Creates a new AMI session.	201
ami_SessionDestroy()	Destroys the AMI session.	203
ami_SessionAnnounce()	Activates the AMI session.	204
ami_SessionStop()	Stops (deactivates) the AMI session.	205
ami_SessionGetName()	Gets the name string of AMI session (microagent).	206
ami_SessionGetDisplayName()	Get the user-friendly name string of AMI session (microagent).	207
ami_SessionGetHelp()	Gets the descriptive text string of AMI session (microagent).	208
ami_SessionGetUserData()	Returns the user data of the specified AMI session.	209
ami_SessionSendData()	Returns data for the specified asynchronous method subscription.	210
ami_SessionSendError()	Reports an error condition for the specified asynchronous method subscription.	211
ami_SessionOnData()	Calls the ami_OnInvokeCallback function of the specified AMI asynchronous method once for each currently active subscription.	212
ami_SessionSendUnsolicitedMsg()	Send an unsolicited message to any interested subscribers.	213

Copyright © Cloud Software Group, Inc. All Rights Reserved