Public Member Functions | Protected Attributes

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

Inherits org::omg::CosNotifyComm::StructuredPushConsumerPOA.

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

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 
)

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  ) 

Close the threads and free all the resources

Parameters:
sync If it is true wait the termination of the threads before returning

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

void com.cosylab.logging.engine.ACS.ACSStructuredPushConsumer.connect (  ) 
void com.cosylab.logging.engine.ACS.ACSStructuredPushConsumer.destroy (  ) 
void com.cosylab.logging.engine.ACS.ACSStructuredPushConsumer.disconnect_structured_push_consumer (  ) 

Check if the consumer is connected by reconnecting the channel

Returns:
true if the consumer is connected

References com.cosylab.logging.engine.ACS.ACSStructuredPushConsumer.structuredProxyPushSupplier.

Referenced by com.cosylab.logging.engine.ACS.ACSStructuredPushConsumer.connect().

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

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
void com.cosylab.logging.engine.ACS.ACSStructuredPushConsumer.push_structured_event ( StructuredEvent  event  )  throws org.omg.CosEventComm.Disconnected

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

References com.cosylab.logging.engine.ACS.ACSLogRetrieval.addLog().

void com.cosylab.logging.engine.ACS.ACSStructuredPushConsumer.setSupended ( boolean  suspended  ) 

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 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 (  ) 
void com.cosylab.logging.engine.ACS.ACSStructuredPushConsumer.teardownEvents (  ) 

Member Data Documentation


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Properties