io.aeron.driver

Class IpcPublication

java.lang.Object

io.aeron.driver.IpcPublication

All Implemented Interfaces:

DriverManagedResource, Subscribable

public final class IpcPublication
extends java.lang.Object
implements DriverManagedResource, Subscribable

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

Constructor Summary

Constructors

Constructor and Description
IpcPublication(long registrationId, long tag, int sessionId, int streamId, org.agrona.concurrent.status.Position publisherPos, org.agrona.concurrent.status.Position publisherLimit, RawLog rawLog, long unblockTimeoutNs, long lingerTimeoutNs, long nowNs, SystemCounters systemCounters, boolean isExclusive)

Method Summary

Modifier and Type	Method and Description
void	addSubscriber(org.agrona.concurrent.status.ReadablePosition subscriberPosition) Add a subscriber identified by its position.
void	close() Close resources that are not external.
void	decRef()
boolean	free() Free external resources such as files.
boolean	hasReachedEndOfLife() Has resource reached end of its life and should be reclaimed?
void	incRef()
boolean	isExclusive()
int	mtuLength()
void	onTimeEvent(long timeNs, long timeMs, DriverConductor conductor) Inform resource of timeNs passing and pass it DriverConductor to inform of any state transitions.
int	publisherLimitId()
RawLog	rawLog()
long	registrationId()
void	removeSubscriber(org.agrona.concurrent.status.ReadablePosition subscriberPosition) Remove a subscriber identified by its position.
int	sessionId()
int	streamId()
long	tag()
int	termBufferLength()

Methods inherited from class java.lang.Object

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

Constructor Detail

IpcPublication

public IpcPublication(long registrationId,
                      long tag,
                      int sessionId,
                      int streamId,
                      org.agrona.concurrent.status.Position publisherPos,
                      org.agrona.concurrent.status.Position publisherLimit,
                      RawLog rawLog,
                      long unblockTimeoutNs,
                      long lingerTimeoutNs,
                      long nowNs,
                      SystemCounters systemCounters,
                      boolean isExclusive)

Method Detail

sessionId

public int sessionId()

streamId

public int streamId()

registrationId

public long registrationId()

tag

public long tag()

isExclusive

public boolean isExclusive()

rawLog

public RawLog rawLog()

publisherLimitId

public int publisherLimitId()

termBufferLength

public int termBufferLength()

mtuLength

public int mtuLength()

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

addSubscriber

public void addSubscriber(org.agrona.concurrent.status.ReadablePosition subscriberPosition)

Description copied from interface: Subscribable

Add a subscriber identified by its position.

Specified by:

addSubscriber in interface Subscribable

Parameters:

subscriberPosition - for tracking and identifying the subscriber.

removeSubscriber

public void removeSubscriber(org.agrona.concurrent.status.ReadablePosition subscriberPosition)

Description copied from interface: Subscribable

Remove a subscriber identified by its position.

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

Specified by:

removeSubscriber in interface Subscribable

Parameters:

subscriberPosition - to be identified by.

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

incRef

public void incRef()

decRef

public void decRef()