com::cosylab::logging::engine::ACS::ACSStructuredPushConsumer Class Reference

Collaboration diagram for com::cosylab::logging::engine::ACS::ACSStructuredPushConsumer:

[legend]List of all members.

Public Member Functions
	ACSStructuredPushConsumer (ACSRemoteAccess acsra, ACSListenersDispatcher listenersDispatcher, ACSLogRetrieval logRetrieval, boolean binaryFormat)
void	connect ()
void	destroy ()
void	disconnect_structured_push_consumer ()
boolean	isInitialized ()
void	offer_change (org.omg.CosNotification.EventType[] added, org.omg.CosNotification.EventType[] removed) throws org.omg.CosNotifyComm.InvalidEventType
void	push_structured_event (StructuredEvent event) throws org.omg.CosEventComm.Disconnected
void	setupEvents ()
void	teardownEvents ()
boolean	isConnected ()
boolean	isSuspended ()
void	setSupended (boolean suspended)
void	close (boolean sync)
Protected Attributes
StructuredProxyPushSupplier	structuredProxyPushSupplier = null
boolean	isConnected = false
boolean	isEventSetup = false
boolean	isInitialized = false
Private Member Functions
void	initialize ()
Private Attributes
ACSRemoteAccess	acsra = null
boolean	binaryFormat
boolean	suspended = false
ACSListenersDispatcher	listenersDispatcher = null
volatile boolean	closed = false
ACSLogRetrieval	logRetrieval

---

Detailed Description

ACSStructuredPushConsumer gets logs from the NC and stores them in a list called receivedLogs.

It supports binary and XML formats.

---

Constructor & Destructor Documentation

com::cosylab::logging::engine::ACS::ACSStructuredPushConsumer::ACSStructuredPushConsumer (  ACSRemoteAccess  acsra, ACSListenersDispatcher  listenersDispatcher, ACSLogRetrieval  logRetrieval, boolean  binaryFormat )  [inline]

StructuredPushConsumer constructor comment. Parameters: acsra  The remote access obj to ACS NC theEngine  The LCEngine

---

Member Function Documentation

void com::cosylab::logging::engine::ACS::ACSStructuredPushConsumer::close (  boolean  sync  )  [inline]

Close the threads and free all the resources Parameters: sync  If it is true wait the termination of the threads before returning

void com::cosylab::logging::engine::ACS::ACSStructuredPushConsumer::connect (   )  [inline]

Connects the push supplier to the push consumer.

void com::cosylab::logging::engine::ACS::ACSStructuredPushConsumer::destroy (   )  [inline]

void com::cosylab::logging::engine::ACS::ACSStructuredPushConsumer::disconnect_structured_push_consumer (   )  [inline]

void com::cosylab::logging::engine::ACS::ACSStructuredPushConsumer::initialize (   )  [inline, private]

Initializes the parser. Creation date: (10/24/2001 12:48:32 PM)

boolean com::cosylab::logging::engine::ACS::ACSStructuredPushConsumer::isConnected (   )  [inline]

Check if the consumer is connected by reconnecting the channel Returns: true if the consumer is connected

boolean com::cosylab::logging::engine::ACS::ACSStructuredPushConsumer::isInitialized (   )  [inline]

boolean com::cosylab::logging::engine::ACS::ACSStructuredPushConsumer::isSuspended (   )  [inline]

Returns: true if the consumer is suspened

void com::cosylab::logging::engine::ACS::ACSStructuredPushConsumer::offer_change (  org.omg.CosNotification.EventType[]  added, org.omg.CosNotification.EventType[]  removed )  throws org.omg.CosNotifyComm.InvalidEventType [inline]

void com::cosylab::logging::engine::ACS::ACSStructuredPushConsumer::push_structured_event (  StructuredEvent  event  )  throws org.omg.CosEventComm.Disconnected [inline]

Adds all the logs to a list in a synchronized manner.

void com::cosylab::logging::engine::ACS::ACSStructuredPushConsumer::setSupended (  boolean  suspended  )  [inline]

Suspend the notification of the incoming logs The logs received while suspended discarded (i.e. lost forever) See also: LCEngine Parameters: suspend  If true suspend the notification of new logs

void com::cosylab::logging::engine::ACS::ACSStructuredPushConsumer::setupEvents (   )  [inline]

Changes subscription on ConsumerAdmin.

void com::cosylab::logging::engine::ACS::ACSStructuredPushConsumer::teardownEvents (   )  [inline]

Remove subscription on ConsumerAdmin.

---

Member Data Documentation

ACSRemoteAccess com::cosylab::logging::engine::ACS::ACSStructuredPushConsumer::acsra = null [private]

boolean com::cosylab::logging::engine::ACS::ACSStructuredPushConsumer::binaryFormat [private]

volatile boolean com::cosylab::logging::engine::ACS::ACSStructuredPushConsumer::closed = false [private]

boolean com::cosylab::logging::engine::ACS::ACSStructuredPushConsumer::isConnected = false [protected]

boolean com::cosylab::logging::engine::ACS::ACSStructuredPushConsumer::isEventSetup = false [protected]

boolean com::cosylab::logging::engine::ACS::ACSStructuredPushConsumer::isInitialized = false [protected]

ACSListenersDispatcher com::cosylab::logging::engine::ACS::ACSStructuredPushConsumer::listenersDispatcher = null [private]

ACSLogRetrieval com::cosylab::logging::engine::ACS::ACSStructuredPushConsumer::logRetrieval [private]

StructuredProxyPushSupplier com::cosylab::logging::engine::ACS::ACSStructuredPushConsumer::structuredProxyPushSupplier = null [protected]

boolean com::cosylab::logging::engine::ACS::ACSStructuredPushConsumer::suspended = false [private]

If it is suspended then the incoming messages are discarded instead of being notified to the listeners

---

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

• ACSStructuredPushConsumer.java

---