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

Inheritance diagram for com::cosylab::logging::engine::ACS::ACSStructuredPushConsumer:
Inheritance graph
[legend]
Collaboration diagram for com::cosylab::logging::engine::ACS::ACSStructuredPushConsumer:
Collaboration graph
[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

References initialize().


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

References closed.

Referenced by com::cosylab::logging::engine::ACS::ACSRemoteAccess::close().

void com::cosylab::logging::engine::ACS::ACSStructuredPushConsumer::connect (  )  [inline]
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]

Check if the consumer is connected by reconnecting the channel

Returns:
true if the consumer is connected

References structuredProxyPushSupplier.

Referenced by connect().

Referenced by initialize().

boolean com::cosylab::logging::engine::ACS::ACSStructuredPushConsumer::isSuspended (  )  [inline]
Returns:
true if the consumer is suspened

References suspended.

Referenced by com::cosylab::logging::engine::ACS::ACSRemoteAccess::isSupended().

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]
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

References listenersDispatcher, com::cosylab::logging::engine::ACS::ACSListenersDispatcher::publishConnected(), and com::cosylab::logging::engine::ACS::ACSListenersDispatcher::publishSuspended().

Referenced by com::cosylab::logging::engine::ACS::ACSRemoteAccess::setSuspended().

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

Member Data Documentation

Referenced by push_structured_event().

Referenced by close(), and push_structured_event().

Referenced by push_structured_event().

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

Referenced by isSuspended(), and push_structured_event().


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

Generated by  doxygen 1.6.2