alma::acs::nc::ArchiveConsumer Class Reference

Inheritance diagram for alma::acs::nc::ArchiveConsumer:

[legend]Collaboration diagram for alma::acs::nc::ArchiveConsumer:

[legend]List of all members.

Public Member Functions
	ArchiveConsumer (ContainerServicesBase services, Object receiver) throws AcsJException
void	push_structured_event (StructuredEvent structuredEvent)
Protected Member Functions
String	getChannelKind ()
String	getNotificationFactoryName ()
void	configSubscriptions ()
Private Attributes
Method	receiveMethod_m = null
Object	receiver_m = null

---

Detailed Description

ArchiveConsumer is a a Consumer-derived class designed solely for the purpose of processing notification channel structured events sent automatically by BACI properties under certain conditions. Basically all one has to do to use this class is create an ArchiveConsumer object providing an object with implements "receive(Long timeStamp, String device, String parameter, Object value)" and then invoke the consumerReady() method. Since archive events do not contain complex IDL structs, filtering using the extended trader constraint language should work as well.

Author:

dfugate

---

Constructor & Destructor Documentation

alma::acs::nc::ArchiveConsumer::ArchiveConsumer (  ContainerServicesBase  services, Object  receiver )  throws AcsJException [inline]

Creates a new instance of ArchiveConsumer Parameters: services  This is used to access ACS logging system. receiver  An object which implements a method called "receive". The "receive" method must accept four parameters which are: timeStamp(long), device(string), parameter(string), and value(Object). Exceptions: AcsJException  Thrown on any really bad error conditions encountered.

---

Member Function Documentation

void alma::acs::nc::ArchiveConsumer::configSubscriptions (   )  [inline, protected]

Overridden Reimplemented from alma::acs::nc::Consumer.

String alma::acs::nc::ArchiveConsumer::getChannelKind (   )  [inline, protected]

Overridden Returns: string Reimplemented from alma::acs::nc::Consumer.

String alma::acs::nc::ArchiveConsumer::getNotificationFactoryName (   )  [inline, protected]

Overridden. Returns: string Reimplemented from alma::acs::nc::Consumer.

void alma::acs::nc::ArchiveConsumer::push_structured_event (  StructuredEvent  structuredEvent  )  [inline]

Overridden. Parameters: structuredEvent  CORBA NC StructuredEvent Exceptions: Disconnected  Reimplemented from alma::acs::nc::Consumer.

---

Member Data Documentation

Method alma::acs::nc::ArchiveConsumer::receiveMethod_m = null [private]

There is exactly one receive method that will be invoked per ArchiveConsumer object.

Object alma::acs::nc::ArchiveConsumer::receiver_m = null [private]

There is exactly one receiver that will be used by each ArchiveConsumer object.

---

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

• ArchiveConsumer.java

---