io.aeron.status

Class ChannelEndpointStatus

java.lang.Object

io.aeron.status.ChannelEndpointStatus

public class ChannelEndpointStatus
extends Object

Status of the Aeron media channel for a Publication or Subscription.

Field Summary

Fields

Modifier and Type	Field and Description
static long	ACTIVE Channel has finished initialization successfully and is active.
static int	CHANNEL_OFFSET Offset in the key metadata for the channel of the counter.
static long	CLOSING Channel is being closed.
static long	ERRORED Channel has errored.
static long	INITIALIZING Channel is being initialized.
static int	MAX_CHANNEL_LENGTH The maximum length in bytes of the encoded channel identity.
static int	NO_ID_ALLOCATED No counter ID is allocated yet.

Constructor Summary

Constructors

Constructor and Description
ChannelEndpointStatus()

Method Summary

Modifier and Type	Method and Description
static AtomicCounter	allocate(MutableDirectBuffer tempBuffer, String name, int typeId, CountersManager countersManager, long registrationId, String channel) Allocate an indicator for tracking the status of a channel endpoint.
static String	status(long status) String representation of the channel status.

Methods inherited from class java.lang.Object

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

Field Detail

INITIALIZING

public static final long INITIALIZING

Channel is being initialized.

See Also:

Constant Field Values

ERRORED

public static final long ERRORED

Channel has errored. Check error log for information.

See Also:

Constant Field Values

ACTIVE

public static final long ACTIVE

Channel has finished initialization successfully and is active.

See Also:

Constant Field Values

CLOSING

public static final long CLOSING

Channel is being closed.

See Also:

Constant Field Values

NO_ID_ALLOCATED

public static final int NO_ID_ALLOCATED

No counter ID is allocated yet.

See Also:

Constant Field Values

CHANNEL_OFFSET

public static final int CHANNEL_OFFSET

Offset in the key metadata for the channel of the counter.

See Also:

Constant Field Values

MAX_CHANNEL_LENGTH

public static final int MAX_CHANNEL_LENGTH

The maximum length in bytes of the encoded channel identity.

See Also:

Constant Field Values

Constructor Detail

ChannelEndpointStatus

public ChannelEndpointStatus()

Method Detail

status

public static String status(long status)

String representation of the channel status.

Parameters:

status - to be converted.

Returns:

representation of the channel status.

allocate

public static AtomicCounter allocate(MutableDirectBuffer tempBuffer,
                                     String name,
                                     int typeId,
                                     CountersManager countersManager,
                                     long registrationId,
                                     String channel)

Allocate an indicator for tracking the status of a channel endpoint.

Parameters:

tempBuffer - to be used for labels and metadata.

name - of the counter for the label.

typeId - of the counter for classification.

countersManager - from which the underlying storage is allocated.

registrationId - of the action the counter is associated with.

channel - for the stream of messages.

Returns:

a new AtomicCounter for tracking the status.