io.aeron.driver.status

Class SubscriberPos

java.lang.Object

io.aeron.driver.status.SubscriberPos

public class SubscriberPos
extends Object

The position an individual Subscriber has reached on a session-channel-stream tuple. It is possible to have multiple Subscribers on the same machine tracked by a MediaDriver.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME Human readable name for the counter.
static int	SUBSCRIBER_POSITION_TYPE_ID Type id of a subscriber position counter.

Constructor Summary

Constructors

Constructor and Description
SubscriberPos()

Method Summary

Modifier and Type	Method and Description
static UnsafeBufferPosition	allocate(MutableDirectBuffer tempBuffer, CountersManager countersManager, long clientId, long registrationId, int sessionId, int streamId, String channel, long joinPosition) Allocate a new subscriber position counter for a stream.

Methods inherited from class java.lang.Object

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

Field Detail

SUBSCRIBER_POSITION_TYPE_ID

public static final int SUBSCRIBER_POSITION_TYPE_ID

Type id of a subscriber position counter.

See Also:

Constant Field Values

NAME

public static final String NAME

Human readable name for the counter.

See Also:

Constant Field Values

Constructor Detail

SubscriberPos

public SubscriberPos()

Method Detail

allocate

public static UnsafeBufferPosition allocate(MutableDirectBuffer tempBuffer,
                                            CountersManager countersManager,
                                            long clientId,
                                            long registrationId,
                                            int sessionId,
                                            int streamId,
                                            String channel,
                                            long joinPosition)

Allocate a new subscriber position counter for a stream.

Parameters:

tempBuffer - to build the label.

countersManager - to allocate the counter from.

clientId - that owns the subscription.

registrationId - associated with the counter.

sessionId - associated with the counter.

streamId - associated with the counter.

channel - associated with the counter.

joinPosition - for the stream.

Returns:

the allocated counter.