dk.dma.ais.packet

Interface AisPacketStream.Subscription

Enclosing class:

AisPacketStream

public static interface AisPacketStream.Subscription

A subcription is created each time a new consumer is added to the stream.

Method Summary

Modifier and Type	Method and Description
void	awaitCancelled() Await cancelled.
boolean	awaitCancelled(long timeout, TimeUnit unit) Await cancelled boolean.
void	cancel() Cancels this subscription.
boolean	isCancelled() Returns whether or not the subscription has been cancelled.

Method Detail

awaitCancelled

void awaitCancelled()
             throws InterruptedException

Await cancelled.

Throws:

InterruptedException - the interrupted exception

awaitCancelled

boolean awaitCancelled(long timeout,
                       TimeUnit unit)
                throws InterruptedException

Await cancelled boolean.

Parameters:

timeout - the timeout

unit - the unit

Returns:

the boolean

Throws:

InterruptedException - the interrupted exception

cancel

void cancel()

Cancels this subscription. After this subscription has been cancelled. No more packets will be delivered to the consumer.

isCancelled

boolean isCancelled()

Returns whether or not the subscription has been cancelled. @return the boolean

Returns:

the boolean