io.aeron.driver

Class SubscriptionLink

java.lang.Object

io.aeron.driver.SubscriptionLink

All Implemented Interfaces:

DriverManagedResource

public abstract class SubscriptionLink
extends java.lang.Object
implements DriverManagedResource

Subscription registration from a client used for liveness tracking

Field Summary

Fields

Modifier and Type	Field and Description
protected AeronClient	aeronClient
protected java.lang.String	channel
protected boolean	hasSessionId
protected boolean	isSparse
protected java.util.Map<Subscribable,org.agrona.concurrent.status.ReadablePosition>	positionBySubscribableMap
protected boolean	reachedEndOfLife
protected long	registrationId
protected int	sessionId
protected int	streamId

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SubscriptionLink(long registrationId, int streamId, java.lang.String channel, AeronClient aeronClient, io.aeron.driver.SubscriptionParams params)

Method Summary

Modifier and Type	Method and Description
java.lang.String	channel()
ReceiveChannelEndpoint	channelEndpoint()
void	close() Close resources that are not external.
boolean	hasReachedEndOfLife() Has resource reached end of its life and should be reclaimed?
boolean	hasSessionId()
boolean	isLinked(Subscribable subscribable)
boolean	isReliable()
boolean	isSparse()
boolean	isWildcardOrSessionIdMatch(int sessionId)
void	link(Subscribable subscribable, org.agrona.concurrent.status.ReadablePosition position)
boolean	matches(IpcPublication publication)
boolean	matches(NetworkPublication publication)
boolean	matches(PublicationImage image)
boolean	matches(ReceiveChannelEndpoint channelEndpoint, int streamId, int sessionId)
boolean	matches(ReceiveChannelEndpoint channelEndpoint, int streamId, io.aeron.driver.SubscriptionParams params)
void	onTimeEvent(long timeNs, long timeMs, DriverConductor conductor) Inform resource of timeNs passing and pass it DriverConductor to inform of any state transitions.
long	registrationId()
int	sessionId()
int	streamId()
void	unlink(Subscribable subscribable)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.aeron.driver.DriverManagedResource

free

Field Detail

registrationId

protected final long registrationId

streamId

protected final int streamId

sessionId

protected final int sessionId

hasSessionId

protected final boolean hasSessionId

isSparse

protected final boolean isSparse

channel

protected final java.lang.String channel

aeronClient

protected final AeronClient aeronClient

positionBySubscribableMap

protected final java.util.Map<Subscribable,org.agrona.concurrent.status.ReadablePosition> positionBySubscribableMap

reachedEndOfLife

protected boolean reachedEndOfLife

Constructor Detail

SubscriptionLink

protected SubscriptionLink(long registrationId,
                           int streamId,
                           java.lang.String channel,
                           AeronClient aeronClient,
                           io.aeron.driver.SubscriptionParams params)

Method Detail

registrationId

public long registrationId()

streamId

public int streamId()

sessionId

public int sessionId()

channel

public java.lang.String channel()

channelEndpoint

public ReceiveChannelEndpoint channelEndpoint()

isReliable

public boolean isReliable()

isSparse

public boolean isSparse()

hasSessionId

public boolean hasSessionId()

matches

public boolean matches(NetworkPublication publication)

matches

public boolean matches(PublicationImage image)

matches

public boolean matches(IpcPublication publication)

matches

public boolean matches(ReceiveChannelEndpoint channelEndpoint,
                       int streamId,
                       io.aeron.driver.SubscriptionParams params)

matches

public boolean matches(ReceiveChannelEndpoint channelEndpoint,
                       int streamId,
                       int sessionId)

isLinked

public boolean isLinked(Subscribable subscribable)

link

public void link(Subscribable subscribable,
                 org.agrona.concurrent.status.ReadablePosition position)

unlink

public void unlink(Subscribable subscribable)

close

public void close()

Description copied from interface: DriverManagedResource

Close resources that are not external.

Specified by:

close in interface DriverManagedResource

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

isWildcardOrSessionIdMatch

public boolean isWildcardOrSessionIdMatch(int sessionId)