acsnc::ACSEventAdmin Interface Reference

import "acsnc.idl";

Inheritance diagram for acsnc::ACSEventAdmin:

Collaboration diagram for acsnc::ACSEventAdmin:

List of all members.

Public Member Functions
boolean	authenticate (in string token)
void	createChannel (in string channelName, in CosNotification::QoSProperties initialQOS, in CosNotification::AdminProperties initialAdmin)
void	configChannelProperties (in string channelName, in CosNotification::QoSProperties newQOS, in CosNotification::AdminProperties newAdmin)
void	destroyChannel (in string channelName)
void	getChannelInfo (in string channelName, out unsigned short numSuppliers, out unsigned short numConsumers, out unsigned long long totalEvents, out CosNotification::QoSProperties initialQOS, out CosNotification::AdminProperties initialAdmin, out NCSeq eventTypes)
NCSeq	getActiveChannels ()
void	monitorEvents (in ACS::CBstring cb, in ACS::CBDescIn desc)

---

Detailed Description

A high-level interface designed to manipulate the CORBA notification service. This includes channel creation, destruction, and monitoring of events among other things. Exception handling for the various methods has yet to be determined.

---

Member Function Documentation

boolean acsnc::ACSEventAdmin::authenticate

(

in string

token

)

Enables methods that change the internal state of the Notification Service (e.g., createChannel, destroyChannel, etc.). Really this is just a rudimentary security mechanism (to be replaced in some future version of ACS) to discourage meddling of the Notification Service from objexp.

Parameters:

token

A security token known only by the implementation of this IDL interface.

Returns:

true if the methods are enabled.

---

void acsnc::ACSEventAdmin::configChannelProperties	(	in string	channelName,
		in CosNotification::QoSProperties	newQOS,
		in CosNotification::AdminProperties	newAdmin
	)

Reconfigures the channel's properties after it has already been created. Note that some properties cannot be changed after the channel has been instantiated.

Parameters:

	channelName	The name of the channel (registered with the CORBA Naming Service).
	newQOS	The new quality of service properties defining the channel. An empty QoSProperties sequence is valid.
	initialAdmin	The new administrative properties defining the channel. An empty AdminProperties sequence is valid.

void acsnc::ACSEventAdmin::createChannel	(	in string	channelName,
		in CosNotification::QoSProperties	initialQOS,
		in CosNotification::AdminProperties	initialAdmin
	)

Creates a channel.

Parameters:

	channelName	The name of the channel (registered with the CORBA Naming Service).
	initialQOS	The initial quality of service properties defining the channel. An empty QoSProperties sequence is valid.
	initialAdmin	The initial administrative properties defining the channel. An empty AdminProperties sequence is valid.

void acsnc::ACSEventAdmin::destroyChannel

(

in string

channelName

)

Destroys a channel and unregisters it from the Naming Service.

Parameters:

channelName

The name of the channel (registered with the CORBA Naming Service).

NCSeq acsnc::ACSEventAdmin::getActiveChannels

(

)

Returns a list of channel names created by the ACS event channel API.

Returns:

A string sequence of channel names that have been registered with the CORBA Naming Service.

---

void acsnc::ACSEventAdmin::getChannelInfo	(	in string	channelName,
		out unsigned short	numSuppliers,
		out unsigned short	numConsumers,
		out unsigned long long	totalEvents,
		out CosNotification::QoSProperties	initialQOS,
		out CosNotification::AdminProperties	initialAdmin,
		out NCSeq	eventTypes
	)

Returns various bits of useful information associated with a particular channel.

Parameters:

	channelName	The name of the channel (registered with the CORBA Naming Service).
	numSuppliers	The total number of suppliers on the channel.
	numConsumers	The total number of consumers on this channel.
	totalEvents	The total number of events that have been sent on this channel.
	initialQOS	The Quality of Service properties associated with this channel.
	initialAdmin	The administrative properties associated with this channel.
	eventTypes	The type events that have been receieved so far.

void acsnc::ACSEventAdmin::monitorEvents	(	in ACS::CBstring	cb,
		in ACS::CBDescIn	desc
	)

Monitors all events from all channels via a single CBstring object. DWF-perhaps the BACI CB interface should be subclassed within this module and have a user-defined struct (defined by Exec or HLA) passed to the working/done callback methods instead of a simple string...

Parameters:

	format	The structure of the string the event will be formatted to. The various ways this can be done have yet to be determined.
	cb	CBstring instance which will have the working method invoked each time an event is received.
	desc	Used to negotiate timeouts between client and server.

---

The documentation for this interface was generated from the following file:

• acsnc.idl