dk.dma.ais.bus

Class AisBus

java.lang.Object

dk.dma.ais.bus.AisBusComponent

dk.dma.ais.bus.AisBus

All Implemented Interfaces:

Runnable

@ThreadSafe
public class AisBus
extends AisBusComponent
implements Runnable

Bus for exchanging AIS packets

Thread safety by delegation

Field Summary

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

filters, packetTransformers, status, THREAD_STOP_WAIT_MAX

Constructor Summary

Constructors

Constructor and Description
AisBus() Instantiates a new Ais bus.

Method Summary

Modifier and Type	Method and Description
double	avgOverflowRate() Get the average overflow rate experienced by all providers
void	cancel() All components must implement a way to stop
AisBusConsumer	getConsumer(String name) Get consumer by name
Set<AisBusConsumer>	getConsumers() Gets consumers.
AisBusProvider	getProvider(String name) Get provider by name
Set<AisBusProvider>	getProviders() Gets providers.
void	init() Initialize AisBus
boolean	push(AisPacket packet) Push packets non-blocking on to the bus
boolean	push(AisPacket packet, boolean blocking) Push element onto the bus.
void	registerConsumer(AisBusConsumer consumer) Register a consumer
void	registerProvider(AisBusProvider provider) Register a provider
void	run() Thread method that distributes elements
void	setBusPullMaxElements(int busPullMaxElements) Sets bus pull max elements.
void	setBusQueueSize(int busQueueSize) Sets bus queue size.
void	start() Start AisBus thread
void	startConsumers() Start all consumers
void	startProviders() Start all providers
void	stopConsumers() Stop all consumers
void	stopProviders() Stop all providers

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

AisBus

public AisBus()

Instantiates a new Ais bus.

Method Detail

init

public void init()

Initialize AisBus

Overrides:

init in class AisBusComponent

start

public void start()

Start AisBus thread

Overrides:

start in class AisBusComponent

cancel

public void cancel()

Description copied from class: AisBusComponent

All components must implement a way to stop

Specified by:

cancel in class AisBusComponent

startConsumers

public void startConsumers()

Start all consumers

stopConsumers

public void stopConsumers()

Stop all consumers

startProviders

public void startProviders()

Start all providers

stopProviders

public void stopProviders()

Stop all providers

push

public boolean push(AisPacket packet)

Push packets non-blocking on to the bus

Parameters:

packet - the packet

Returns:

if pushing was a success

push

public boolean push(AisPacket packet,
                    boolean blocking)

Push element onto the bus. Returns false if the bus is overflowing

Parameters:

packet - the packet

blocking - the blocking

Returns:

if pushing was a success

avgOverflowRate

public double avgOverflowRate()

Get the average overflow rate experienced by all providers

Returns:

double double

registerConsumer

public void registerConsumer(AisBusConsumer consumer)

Register a consumer

Parameters:

consumer - the consumer

getConsumer

public AisBusConsumer getConsumer(String name)

Get consumer by name

Parameters:

name - the name

Returns:

consumer consumer

getProvider

public AisBusProvider getProvider(String name)

Get provider by name

Parameters:

name - the name

Returns:

provider provider

registerProvider

public void registerProvider(AisBusProvider provider)

Register a provider

Parameters:

provider - the provider

run

public void run()

Thread method that distributes elements

Specified by:

run in interface Runnable

setBusPullMaxElements

public void setBusPullMaxElements(int busPullMaxElements)

Sets bus pull max elements.

Parameters:

busPullMaxElements - the bus pull max elements

setBusQueueSize

public void setBusQueueSize(int busQueueSize)

Sets bus queue size.

Parameters:

busQueueSize - the bus queue size

getConsumers

public Set<AisBusConsumer> getConsumers()

Gets consumers.

Returns:

the consumers

getProviders

public Set<AisBusProvider> getProviders()

Gets providers.

Returns:

the providers