io.aeron.cluster.service.ConsensusModuleProxy Maven / Gradle / Ivy
Show all versions of aeron-all Show documentation
/*
* Copyright 2014-2024 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.cluster.service;
import io.aeron.DirectBufferVector;
import io.aeron.Publication;
import io.aeron.cluster.client.AeronCluster;
import io.aeron.cluster.client.ClusterException;
import io.aeron.cluster.codecs.*;
import io.aeron.logbuffer.BufferClaim;
import org.agrona.CloseHelper;
import org.agrona.DirectBuffer;
/**
* Proxy for communicating with the Consensus Module over IPC.
*
* Note: This class is not for public use.
*/
public final class ConsensusModuleProxy implements AutoCloseable
{
private final BufferClaim bufferClaim = new BufferClaim();
private final MessageHeaderEncoder messageHeaderEncoder = new MessageHeaderEncoder();
private final ScheduleTimerEncoder scheduleTimerEncoder = new ScheduleTimerEncoder();
private final CancelTimerEncoder cancelTimerEncoder = new CancelTimerEncoder();
private final ServiceAckEncoder serviceAckEncoder = new ServiceAckEncoder();
private final CloseSessionEncoder closeSessionEncoder = new CloseSessionEncoder();
private final ClusterMembersQueryEncoder clusterMembersQueryEncoder = new ClusterMembersQueryEncoder();
private final Publication publication;
/**
* Construct a proxy to the consensus module that will send messages over a provided {@link Publication}.
*
* @param publication for sending messages to the consensus module.
*/
public ConsensusModuleProxy(final Publication publication)
{
this.publication = publication;
}
/**
* {@inheritDoc}
*/
public void close()
{
CloseHelper.close(publication);
}
boolean scheduleTimer(final long correlationId, final long deadline)
{
final int length = MessageHeaderEncoder.ENCODED_LENGTH + ScheduleTimerEncoder.BLOCK_LENGTH;
final long position = publication.tryClaim(length, bufferClaim);
if (position > 0)
{
scheduleTimerEncoder
.wrapAndApplyHeader(bufferClaim.buffer(), bufferClaim.offset(), messageHeaderEncoder)
.correlationId(correlationId)
.deadline(deadline);
bufferClaim.commit();
return true;
}
checkResult(position, publication);
return false;
}
boolean cancelTimer(final long correlationId)
{
final int length = MessageHeaderEncoder.ENCODED_LENGTH + CancelTimerEncoder.BLOCK_LENGTH;
final long position = publication.tryClaim(length, bufferClaim);
if (position > 0)
{
cancelTimerEncoder
.wrapAndApplyHeader(bufferClaim.buffer(), bufferClaim.offset(), messageHeaderEncoder)
.correlationId(correlationId);
bufferClaim.commit();
return true;
}
checkResult(position, publication);
return false;
}
long offer(
final DirectBuffer headerBuffer,
final int headerOffset,
final int headerLength,
final DirectBuffer messageBuffer,
final int messageOffset,
final int messageLength)
{
final long position = publication.offer(
headerBuffer, headerOffset, headerLength, messageBuffer, messageOffset, messageLength);
if (position < 0)
{
checkResult(position, publication);
}
return position;
}
long offer(final DirectBufferVector[] vectors)
{
final long position = publication.offer(vectors, null);
if (position < 0)
{
checkResult(position, publication);
}
return position;
}
long tryClaim(final int length, final BufferClaim bufferClaim, final DirectBuffer sessionHeader)
{
final long position = publication.tryClaim(length, bufferClaim);
if (position > 0)
{
bufferClaim.putBytes(sessionHeader, 0, AeronCluster.SESSION_HEADER_LENGTH);
}
else
{
checkResult(position, publication);
}
return position;
}
boolean ack(
final long logPosition, final long timestamp, final long ackId, final long relevantId, final int serviceId)
{
final int length = MessageHeaderEncoder.ENCODED_LENGTH + ServiceAckEncoder.BLOCK_LENGTH;
final long position = publication.tryClaim(length, bufferClaim);
if (position > 0)
{
serviceAckEncoder
.wrapAndApplyHeader(bufferClaim.buffer(), bufferClaim.offset(), messageHeaderEncoder)
.logPosition(logPosition)
.timestamp(timestamp)
.ackId(ackId)
.relevantId(relevantId)
.serviceId(serviceId);
bufferClaim.commit();
return true;
}
checkResult(position, publication);
return false;
}
boolean closeSession(final long clusterSessionId)
{
final int length = MessageHeaderEncoder.ENCODED_LENGTH + CloseSessionEncoder.BLOCK_LENGTH;
final long position = publication.tryClaim(length, bufferClaim);
if (position > 0)
{
closeSessionEncoder
.wrapAndApplyHeader(bufferClaim.buffer(), bufferClaim.offset(), messageHeaderEncoder)
.clusterSessionId(clusterSessionId);
bufferClaim.commit();
return true;
}
checkResult(position, publication);
return false;
}
/**
* Query for the current cluster members.
*
* @param correlationId for the request.
* @return true of the request was successfully sent, otherwise false.
*/
public boolean clusterMembersQuery(final long correlationId)
{
final int length = MessageHeaderEncoder.ENCODED_LENGTH + ClusterMembersQueryEncoder.BLOCK_LENGTH;
final long position = publication.tryClaim(length, bufferClaim);
if (position > 0)
{
clusterMembersQueryEncoder
.wrapAndApplyHeader(bufferClaim.buffer(), bufferClaim.offset(), messageHeaderEncoder)
.correlationId(correlationId)
.extended(BooleanType.TRUE);
bufferClaim.commit();
return true;
}
checkResult(position, publication);
return false;
}
private static void checkResult(final long position, final Publication publication)
{
if (Publication.NOT_CONNECTED == position)
{
throw new ClusterException("publication is not connected");
}
if (Publication.CLOSED == position)
{
throw new ClusterException("publication is closed");
}
if (Publication.MAX_POSITION_EXCEEDED == position)
{
throw new ClusterException("publication at max position: term-length=" + publication.termBufferLength());
}
}
}