dk.dma.ais.reader

Class AisReader

java.lang.Object

java.lang.Thread

dk.dma.ais.reader.AisReader

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

AisDirectoryReader, AisStreamReader, AisTcpReader, AisUdpReader

public abstract class AisReader
extends Thread

Abstract base for classes reading from an AIS source. Also handles ABK and a number of proprietary sentences.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AisReader.Status The enum Status.

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected CopyOnWriteArrayList<Consumer<AisMessage>>	handlers List receivers for the AIS messages.
protected CopyOnWriteArrayList<Consumer<? super AisPacket>>	packetHandlers List of packet handlers.
protected SendThreadPool	sendThreadPool A pool of sending threads.

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
AisReader()

Method Summary

Modifier and Type	Method and Description
protected void	distribute(AisPacket packet) Distribute.
protected void	doSend(SendRequest sendRequest, Consumer<Abk> resultListener, OutputStream out) The method to do the actual sending
long	getNumberOfBytesRead() Gets number of bytes read.
long	getNumberOfBytesWritten() Gets number of bytes written.
long	getNumberOfLinesRead() Gets number of lines read.
String	getSourceId() Gets source id.
abstract AisReader.Status	getStatus() Get the status of the connection, either connected or disconnected
protected boolean	isShutdown() Is shutdown boolean.
protected void	readLoop(InputStream stream) The main read loop to use if sentences in stream
void	registerHandler(Consumer<AisMessage> aisHandler) Add an AIS handler
void	registerPacketHandler(Consumer<? super AisPacket> packetConsumer) Add a packet handler
void	registerQueue(IMessageQueue<AisMessage> queue) Add a queue for receiving messages
void	registerQueueHandler(IQueueEntryHandler<AisMessage> handler) Make a new queue and reader for the queue.
Abk	send(AisMessage aisMessage, int sequence, int destination) Sending with 60 sec default timeout
Abk	send(AisMessage aisMessage, int sequence, int destination, int timeout) Blocking method to send message in an easy way
abstract void	send(SendRequest sendRequest, Consumer<Abk> resultListener) Method to send addressed or broadcast AIS messages (ABM or BBM).
void	setSourceId(String sourceId) Sets source id.
void	stopReader() Stop the reader
AisPacketStream	stream() Returns a ais packet stream.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, run, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Field Detail

handlers

protected final CopyOnWriteArrayList<Consumer<AisMessage>> handlers

List receivers for the AIS messages.

packetHandlers

protected final CopyOnWriteArrayList<Consumer<? super AisPacket>> packetHandlers

List of packet handlers.

sendThreadPool

protected final SendThreadPool sendThreadPool

A pool of sending threads. A sending thread handles the sending and reception of ABK message.

Constructor Detail

AisReader

public AisReader()

Method Detail

doSend

protected void doSend(SendRequest sendRequest,
                      Consumer<Abk> resultListener,
                      OutputStream out)
               throws SendException

The method to do the actual sending

Parameters:

sendRequest - the send request

resultListener - the result listener

out - the out

Throws:

SendException - the send exception

getNumberOfBytesRead

public long getNumberOfBytesRead()

Gets number of bytes read.

Returns:

the number of bytes read

getNumberOfBytesWritten

public long getNumberOfBytesWritten()

Gets number of bytes written.

Returns:

the number of bytes written

getNumberOfLinesRead

public long getNumberOfLinesRead()

Gets number of lines read.

Returns:

the number of lines read

getSourceId

public String getSourceId()

Gets source id.

Returns:

the source id

getStatus

public abstract AisReader.Status getStatus()

Get the status of the connection, either connected or disconnected

Returns:

status status

isShutdown

protected boolean isShutdown()

Is shutdown boolean.

Returns:

the boolean

readLoop

protected void readLoop(InputStream stream)
                 throws IOException

The main read loop to use if sentences in stream

Parameters:

stream - the generic input stream to read from

Throws:

IOException - the io exception

distribute

protected void distribute(AisPacket packet)

Distribute.

Parameters:

packet - the packet

registerHandler

public void registerHandler(Consumer<AisMessage> aisHandler)

Add an AIS handler

Parameters:

aisHandler - the ais handler

registerPacketHandler

public void registerPacketHandler(Consumer<? super AisPacket> packetConsumer)

Add a packet handler

Parameters:

packetConsumer - the packet consumer

registerQueue

public void registerQueue(IMessageQueue<AisMessage> queue)

Add a queue for receiving messages

Parameters:

queue - the queue

registerQueueHandler

public void registerQueueHandler(IQueueEntryHandler<AisMessage> handler)

Make a new queue and reader for the queue. Start and attach to to given handler.

Parameters:

handler - the handler

send

public Abk send(AisMessage aisMessage,
                int sequence,
                int destination)
         throws SendException,
                InterruptedException

Sending with 60 sec default timeout

Parameters:

aisMessage - the ais message

sequence - the sequence

destination - the destination

Returns:

abk abk

Throws:

SendException - the send exception

InterruptedException - the interrupted exception

send

public Abk send(AisMessage aisMessage,
                int sequence,
                int destination,
                int timeout)
         throws SendException,
                InterruptedException

Blocking method to send message in an easy way

Parameters:

aisMessage - the ais message

sequence - the sequence

destination - the destination

timeout - the timeout

Returns:

abk abk

Throws:

SendException - the send exception

InterruptedException - the interrupted exception

send

public abstract void send(SendRequest sendRequest,
                          Consumer<Abk> resultListener)
                   throws SendException

Method to send addressed or broadcast AIS messages (ABM or BBM).

Parameters:

sendRequest - the send request

resultListener - A class to handle the result when it is ready.

Throws:

SendException - the send exception

setSourceId

public void setSourceId(String sourceId)

Sets source id.

Parameters:

sourceId - the source id

stopReader

public void stopReader()

Stop the reader

stream

public AisPacketStream stream()

Returns a ais packet stream.

Returns:

the stream