com.cosylab.logging.engine.ACS

Class ACSStructuredPushConsumer

java.lang.Object

StructuredPushConsumerPOA

com.cosylab.logging.engine.ACS.ACSStructuredPushConsumer

public final class ACSStructuredPushConsumer
extends StructuredPushConsumerPOA

ACSStructuredPushConsumer gets logs from the NC and stores them in a list called receivedLogs. It supports binary and XML formats.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isConnected
protected boolean	isEventSetup
protected boolean	isInitialized
protected static java.util.Random	random
protected StructuredProxyPushSupplier	structuredProxyPushSupplier

Constructor Summary

Constructors

Constructor and Description
ACSStructuredPushConsumer(ACSRemoteAccess acsra, ACSListenersDispatcher listenersDispatcher, ACSLogRetrieval logRetrieval) StructuredPushConsumer constructor comment.

Method Summary

Modifier and Type	Method and Description
void	close(boolean sync) Close the threads and free all the resources
void	connect() Connects the push supplier to the push consumer.
static java.lang.String	createUniqueClientName() Copied from jcontnc :: Helper, which we cannot use here because of build order issues.
void	destroy()
void	disconnect_structured_push_consumer()
boolean	isConnected() Check if the consumer is connected by reconnecting the channel
boolean	isInitialized()
boolean	isSuspended()
void	offer_change(org.omg.CosNotification.EventType[] added, org.omg.CosNotification.EventType[] removed)
void	push_structured_event(StructuredEvent event) Adds all the logs to a list in a synchronized manner.
void	setSupended(boolean suspended) Suspend the notification of the incoming logs The logs received while suspended discarded (i.e.
void	setupEvents() Changes subscription on ConsumerAdmin.
void	teardownEvents() Remove subscription on ConsumerAdmin.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

random

protected static final java.util.Random random

structuredProxyPushSupplier

protected StructuredProxyPushSupplier structuredProxyPushSupplier

isConnected

protected boolean isConnected

isEventSetup

protected boolean isEventSetup

isInitialized

protected boolean isInitialized

Constructor Detail

ACSStructuredPushConsumer

public ACSStructuredPushConsumer(ACSRemoteAccess acsra,
                                 ACSListenersDispatcher listenersDispatcher,
                                 ACSLogRetrieval logRetrieval)

StructuredPushConsumer constructor comment.

Parameters:

acsra - The remote access obj to ACS NC

theEngine - The LCEngine

Method Detail

connect

public void connect()

Connects the push supplier to the push consumer.

destroy

public void destroy()

disconnect_structured_push_consumer

public void disconnect_structured_push_consumer()

isInitialized

public boolean isInitialized()

offer_change

public void offer_change(org.omg.CosNotification.EventType[] added,
                         org.omg.CosNotification.EventType[] removed)
                  throws org.omg.CosNotifyComm.InvalidEventType

Throws:

org.omg.CosNotifyComm.InvalidEventType

push_structured_event

public void push_structured_event(StructuredEvent event)
                           throws org.omg.CosEventComm.Disconnected

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

Throws:

org.omg.CosEventComm.Disconnected

setupEvents

public void setupEvents()

Changes subscription on ConsumerAdmin.

teardownEvents

public void teardownEvents()

Remove subscription on ConsumerAdmin.

isConnected

public boolean isConnected()

Check if the consumer is connected by reconnecting the channel

Returns:

true if the consumer is connected

isSuspended

public boolean isSuspended()

Returns:

true if the consumer is suspened

setSupended

public void setSupended(boolean suspended)

Suspend the notification of the incoming logs The logs received while suspended discarded (i.e. lost forever)

Parameters:

suspend - If true suspend the notification of new logs

See Also:

LCEngine

close

public void 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

createUniqueClientName

public static java.lang.String createUniqueClientName()

Copied from jcontnc :: Helper, which we cannot use here because of build order issues.

We need to have a unique client name, even though every jlog instance uses its own consumer admin object. This is different from jcontnc's NCSubscriber class who started with this unique name business. The reason is the TAO MC API "ConsumerNames" statistics used by the eventGUI. It returns "factoryName/channelName/supplierProxyName", which leaves out the admin object, and returns this string only once even if this same path applies to several proxies.