io.aeron.driver

Class PublicationImage

java.lang.Object

io.aeron.driver.PublicationImage

All Implemented Interfaces:

DriverManagedResource, NakMessageSender, org.agrona.ManagedResource

public class PublicationImage
extends java.lang.Object
implements NakMessageSender, DriverManagedResource

State maintained for active sessionIds within a channel for receiver processing

Constructor Summary

Constructors

Constructor and Description

PublicationImage(long correlationId, long imageLivenessTimeoutNs, ReceiveChannelEndpoint channelEndpoint, java.net.InetSocketAddress controlAddress, int sessionId, int streamId, int initialTermId, int activeTermId, int initialTermOffset, int initialWindowLength, RawLog rawLog, FeedbackDelayGenerator lossFeedbackDelayGenerator, java.util.List<org.agrona.concurrent.status.ReadablePosition> subscriberPositions, org.agrona.concurrent.status.Position hwmPosition, org.agrona.concurrent.NanoClock clock, SystemCounters systemCounters, java.net.InetSocketAddress sourceAddress)

Method Summary

Modifier and Type	Method and Description
java.lang.String	channelUriString() Get the string representation of the channel URI.
void	close()
long	correlationId()
void	delete()
boolean	hasReachedEndOfLife() Has resource reached end of its life and should be reclaimed?
boolean	matches(ReceiveChannelEndpoint channelEndpoint, int streamId) Does this image match a given ReceiveChannelEndpoint and stream id?
void	onLossDetected(int termId, int termOffset, int length) Called from the LossDetector when gap is detected.
void	onTimeEvent(long time, DriverConductor conductor) Inform resource of time passing and pass it DriverConductor to inform of any state transitions.
int	sessionId() The session id of the channel from a publisher.
io.aeron.driver.PublicationImage.Status	status() Return status of the image.
void	status(io.aeron.driver.PublicationImage.Status status) Set status of the image.
int	streamId() The stream id of this image within a channel.
long	timeOfLastStateChange()
void	timeOfLastStateChange(long time)

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

consumerPosition, decRef, incRef, producerPosition, unblockAtConsumerPosition

Constructor Detail

PublicationImage

public PublicationImage(long correlationId,
                        long imageLivenessTimeoutNs,
                        ReceiveChannelEndpoint channelEndpoint,
                        java.net.InetSocketAddress controlAddress,
                        int sessionId,
                        int streamId,
                        int initialTermId,
                        int activeTermId,
                        int initialTermOffset,
                        int initialWindowLength,
                        RawLog rawLog,
                        FeedbackDelayGenerator lossFeedbackDelayGenerator,
                        java.util.List<org.agrona.concurrent.status.ReadablePosition> subscriberPositions,
                        org.agrona.concurrent.status.Position hwmPosition,
                        org.agrona.concurrent.NanoClock clock,
                        SystemCounters systemCounters,
                        java.net.InetSocketAddress sourceAddress)

Method Detail

close

public void close()

correlationId

public long correlationId()

sessionId

public int sessionId()

The session id of the channel from a publisher.

Returns:

session id of the channel from a publisher.

streamId

public int streamId()

The stream id of this image within a channel.

Returns:

stream id of this image within a channel.

channelUriString

public java.lang.String channelUriString()

Get the string representation of the channel URI.

Returns:

the string representation of the channel URI.

matches

public boolean matches(ReceiveChannelEndpoint channelEndpoint,
                       int streamId)

Does this image match a given ReceiveChannelEndpoint and stream id?

Parameters:

channelEndpoint - to match by identity.

streamId - to match on value.

Returns:

true on a match otherwise false.

status

public io.aeron.driver.PublicationImage.Status status()

Return status of the image. Retrieved by DriverConductor.

Returns:

status of the image

status

public void status(io.aeron.driver.PublicationImage.Status status)

Set status of the image.

Set by Receiver for INIT to ACTIVE to INACTIVE

Set by DriverConductor for INACTIVE to LINGER

Parameters:

status - of the image

onLossDetected

public void onLossDetected(int termId,
                           int termOffset,
                           int length)

Called from the LossDetector when gap is detected.

Specified by:

onLossDetected in interface NakMessageSender

Parameters:

termId - for the gap

termOffset - for the beginning of the gap

length - of the gap

See Also:

NakMessageSender

onTimeEvent

public void onTimeEvent(long time,
                        DriverConductor conductor)

Description copied from interface: DriverManagedResource

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

Specified by:

onTimeEvent in interface DriverManagedResource

Parameters:

time - now in nanoseconds

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