io.aeron.driver

Class SubscriptionLink

java.lang.Object

io.aeron.driver.SubscriptionLink

All Implemented Interfaces:

DriverManagedResource, org.agrona.ManagedResource

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 long	clientLivenessTimeoutNs
protected java.util.Map<Subscribable,org.agrona.concurrent.status.ReadablePosition>	positionBySubscribableMap
protected boolean	reachedEndOfLife
protected long	registrationId
protected int	streamId
protected java.lang.String	uri

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SubscriptionLink(long registrationId, int streamId, java.lang.String channelUri, AeronClient aeronClient, long clientLivenessTimeoutNs)

Method Summary

Modifier and Type	Method and Description
ReceiveChannelEndpoint	channelEndpoint()
void	close()
void	delete()
boolean	hasReachedEndOfLife() Has resource reached end of its life and should be reclaimed?
boolean	isLinked(Subscribable subscribable)
boolean	isReliable()
void	link(Subscribable subscribable, org.agrona.concurrent.status.ReadablePosition position)
boolean	matches(int streamId)
boolean	matches(NetworkPublication publication)
boolean	matches(ReceiveChannelEndpoint channelEndpoint, int streamId)
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	streamId()
long	timeOfLastStateChange()
void	timeOfLastStateChange(long time)
void	unlink(Subscribable subscribable)
java.lang.String	uri()

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

decRef, incRef

Field Detail

registrationId

protected final long registrationId

clientLivenessTimeoutNs

protected final long clientLivenessTimeoutNs

streamId

protected final int streamId

uri

protected final java.lang.String uri

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 channelUri,
                           AeronClient aeronClient,
                           long clientLivenessTimeoutNs)

Method Detail

registrationId

public long registrationId()

streamId

public int streamId()

uri

public java.lang.String uri()

channelEndpoint

public ReceiveChannelEndpoint channelEndpoint()

isReliable

public boolean isReliable()

matches

public boolean matches(NetworkPublication publication)

matches

public boolean matches(ReceiveChannelEndpoint channelEndpoint,
                       int streamId)

matches

public boolean matches(int streamId)

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()

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

timeOfLastStateChange

public void timeOfLastStateChange(long time)

Specified by:

timeOfLastStateChange in interface org.agrona.ManagedResource

timeOfLastStateChange

public long timeOfLastStateChange()

Specified by:

timeOfLastStateChange in interface org.agrona.ManagedResource

delete

public void delete()

Specified by:

delete in interface org.agrona.ManagedResource