io.aeron.driver.status.SubscriberPos Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aeron-agent Show documentation
Show all versions of aeron-agent Show documentation
Efficient reliable UDP unicast, UDP multicast, and IPC transport protocol.
/*
* Copyright 2014-2023 Real Logic Limited.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.aeron.driver.status;
import io.aeron.AeronCounters;
import org.agrona.MutableDirectBuffer;
import org.agrona.concurrent.status.CountersManager;
import org.agrona.concurrent.status.UnsafeBufferPosition;
/**
* 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 {@link io.aeron.driver.MediaDriver}.
*/
public class SubscriberPos
{
/**
* Type id of a subscriber position counter.
*/
public static final int SUBSCRIBER_POSITION_TYPE_ID = AeronCounters.DRIVER_SUBSCRIBER_POSITION_TYPE_ID;
/**
* Human-readable name for the counter.
*/
public static final String NAME = "sub-pos";
/**
* Allocate a new subscriber position counter for a stream.
*
* @param tempBuffer to build the label.
* @param countersManager to allocate the counter from.
* @param clientId that owns the subscription.
* @param registrationId associated with the counter.
* @param sessionId associated with the counter.
* @param streamId associated with the counter.
* @param channel associated with the counter.
* @param joinPosition for the stream.
* @return the allocated counter.
*/
public static UnsafeBufferPosition allocate(
final MutableDirectBuffer tempBuffer,
final CountersManager countersManager,
final long clientId,
final long registrationId,
final int sessionId,
final int streamId,
final String channel,
final long joinPosition)
{
final UnsafeBufferPosition position = StreamCounter.allocate(
tempBuffer,
NAME,
SUBSCRIBER_POSITION_TYPE_ID,
countersManager,
registrationId,
sessionId,
streamId,
channel,
joinPosition);
countersManager.setCounterOwnerId(position.id(), clientId);
return position;
}
}