dk.dma.ais.bus

Class AisBusConsumer

java.lang.Object

dk.dma.ais.bus.AisBusComponent

dk.dma.ais.bus.AisBusSocket

dk.dma.ais.bus.AisBusConsumer

All Implemented Interfaces:

IQueueEntryHandler<AisBusElement>

Direct Known Subclasses:

DistributerConsumer, StdoutConsumer, TcpServerConsumer, TcpWriterConsumer

@ThreadSafe
public abstract class AisBusConsumer
extends AisBusSocket
implements IQueueEntryHandler<AisBusElement>

The type Ais bus consumer.

Field Summary

Fields inherited from class dk.dma.ais.bus.AisBusSocket

blocking

Fields inherited from class dk.dma.ais.bus.AisBusComponent

filters, packetTransformers, status, THREAD_STOP_WAIT_MAX

Constructor Summary

Constructors

Constructor and Description
AisBusConsumer() Instantiates a new Ais bus consumer.
AisBusConsumer(boolean blocking) Instantiates a new Ais bus consumer.

Method Summary

Modifier and Type	Method and Description
void	cancel() All components must implement a way to stop
void	init() Initialize the component after configuration.
void	push(AisBusElement element) Push elements onto the queue
void	receive(AisBusElement queueElement) Receive elements from the queue
abstract void	receiveFiltered(AisBusElement queueElement) All consumers must implement a method to get the filtered packet
void	setConsumerPullMaxElements(int consumerPullMaxElements) Sets consumer pull max elements.
void	setConsumerQueueSize(int consumerQueueSize) Sets consumer queue size.
void	start() Start the component.

Methods inherited from class dk.dma.ais.bus.AisBusSocket

getAisBus, getDescription, getName, setAisBus, setDescription, setName

Methods inherited from class dk.dma.ais.bus.AisBusComponent

getFilters, getPacketTransformers, getStatus, getThread, handleReceived, rateReport, setConnected, setNotConnected, setStopped, setThread, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AisBusConsumer

public AisBusConsumer()

Instantiates a new Ais bus consumer.

AisBusConsumer

public AisBusConsumer(boolean blocking)

Instantiates a new Ais bus consumer.

Parameters:

blocking - the blocking

Method Detail

receive

public final void receive(AisBusElement queueElement)

Receive elements from the queue

Specified by:

receive in interface IQueueEntryHandler<AisBusElement>

Parameters:

queueElement - the queue entry

push

public final void push(AisBusElement element)

Push elements onto the queue

Parameters:

element - the element

init

public void init()

Description copied from class: AisBusComponent

Initialize the component after configuration. Must be called be starting the component.

Overrides:

init in class AisBusSocket

start

public void start()

Description copied from class: AisBusComponent

Start the component. Must be called after init().

Overrides:

start in class AisBusSocket

cancel

public void cancel()

Description copied from class: AisBusComponent

All components must implement a way to stop

Specified by:

cancel in class AisBusComponent

receiveFiltered

public abstract void receiveFiltered(AisBusElement queueElement)

All consumers must implement a method to get the filtered packet

Parameters:

queueElement - the queue element

setConsumerQueueSize

public void setConsumerQueueSize(int consumerQueueSize)

Sets consumer queue size.

Parameters:

consumerQueueSize - the consumer queue size

setConsumerPullMaxElements

public void setConsumerPullMaxElements(int consumerPullMaxElements)

Sets consumer pull max elements.

Parameters:

consumerPullMaxElements - the consumer pull max elements