io.aeron.driver.status

Class PublisherLimit

java.lang.Object

io.aeron.driver.status.PublisherLimit

public class PublisherLimit
extends Object

The limit as a position in bytes applied to publishers on a session-channel-stream tuple. Publishers will experience back pressure when this position is passed as a means of flow control.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME Human-readable name for the counter.
static int	PUBLISHER_LIMIT_TYPE_ID Type id of a publisher limit counter.

Constructor Summary

Constructors

Constructor and Description
PublisherLimit()

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

PUBLISHER_LIMIT_TYPE_ID

public static final int PUBLISHER_LIMIT_TYPE_ID

Type id of a publisher limit 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

PublisherLimit

public PublisherLimit()

Method Detail

allocate

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

Allocate a new publisher limit counter for a stream.

Parameters:

tempBuffer - to build the label.

countersManager - to allocate the counter from.

registrationId - associated with the counter.

sessionId - associated with the counter.

streamId - associated with the counter.

channel - associated with the counter.

Returns:

the allocated counter.