io.aeron.driver

Class IpcPublication

java.lang.Object

io.aeron.driver.IpcPublication

All Implemented Interfaces:

DriverManagedResource, Subscribable, AutoCloseable

public final class IpcPublication
extends Object
implements DriverManagedResource, Subscribable

Encapsulation of a stream used directly between publishers and subscribers for IPC over shared memory.

Method Summary

Modifier and Type	Method and Description
void	addSubscriber(SubscriptionLink subscriptionLink, ReadablePosition subscriberPosition) Add a subscriber and its position used for tracking consumption.
String	channel() Channel URI string for this publication.
void	close() Close resources that are not external.
boolean	free() Free external resources such as files.
boolean	hasReachedEndOfLife() Has resource reached end of its life and should be reclaimed?
void	onTimeEvent(long timeNs, long timeMs, DriverConductor conductor) Inform resource of timeNs passing and pass it DriverConductor to inform of any state transitions.
void	removeSubscriber(SubscriptionLink subscriptionLink, ReadablePosition subscriberPosition) Remove a subscriber and its position used for tracking consumption.
int	sessionId() Session id allocated to this stream.
int	streamId() Stream id within the channel.

Methods inherited from class java.lang.Object

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

Method Detail

channel

public String channel()

Channel URI string for this publication.

Returns:

channel URI string for this publication.

sessionId

public int sessionId()

Session id allocated to this stream.

Returns:

session id allocated to this stream.

streamId

public int streamId()

Stream id within the channel.

Returns:

stream id within the channel.

free

public boolean free()

Description copied from interface: DriverManagedResource

Free external resources such as files. if successful then return true.

Specified by:

free in interface DriverManagedResource

Returns:

true if successful and false if it should be attempted again later.

close

public void close()

Description copied from interface: DriverManagedResource

Close resources that are not external.

Specified by:

close in interface DriverManagedResource

Specified by:

close in interface AutoCloseable

addSubscriber

public void addSubscriber(SubscriptionLink subscriptionLink,
                          ReadablePosition subscriberPosition)

Description copied from interface: Subscribable

Add a subscriber and its position used for tracking consumption.

Specified by:

addSubscriber in interface Subscribable

Parameters:

subscriptionLink - for identifying the subscriber.

subscriberPosition - for tracking the subscriber.

removeSubscriber

public void removeSubscriber(SubscriptionLink subscriptionLink,
                             ReadablePosition subscriberPosition)

Description copied from interface: Subscribable

Remove a subscriber and its position used for tracking consumption.

Note: The Subscribable is responsible for calling ReadablePosition.close() on removed positions.

Specified by:

removeSubscriber in interface Subscribable

Parameters:

subscriptionLink - for identifying the subscriber.

subscriberPosition - for tracking the subscriber.

onTimeEvent

public void onTimeEvent(long timeNs,
                        long timeMs,
                        DriverConductor conductor)

Description copied from interface: DriverManagedResource

Inform resource of timeNs passing and pass it DriverConductor to inform of any state transitions.

Specified by:

onTimeEvent in interface DriverManagedResource

Parameters:

timeNs - now in nanoseconds.

timeMs - now in milliseconds for epoch.

conductor - to inform of any state transitions.

hasReachedEndOfLife

public boolean hasReachedEndOfLife()

Description copied from interface: DriverManagedResource

Has resource reached end of its life and should be reclaimed?

Specified by:

hasReachedEndOfLife in interface DriverManagedResource

Returns:

whether resource has reached end of life or not.