io.aeron.cluster.service.ClusterTerminationException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aeron-all Show documentation

Efficient reliable UDP unicast, UDP multicast, and IPC transport protocol.

There is a newer version: 1.48.0

/*
 * 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 org.agrona.concurrent.AgentTerminationException;

/**
 * Used to terminate the {@link org.agrona.concurrent.Agent} within a cluster in an expected/unexpected fashion.
 */
public class ClusterTerminationException extends AgentTerminationException
{
    private static final long serialVersionUID = -2705156056823180407L;

    /**
     * Is expected termination?
     */
    private final boolean isExpected;

    /**
     * Construct an exception used to terminate the cluster with {@link #isExpected()} set to true.
     */
    public ClusterTerminationException()
    {
        this(true);
    }

    /**
     * Construct an exception used to terminate the cluster.
     *
     * @param isExpected true if the termination is expected, i.e. it was requested.
     */
    public ClusterTerminationException(final boolean isExpected)
    {
        super(isExpected ? "expected termination" : "unexpected termination");
        this.isExpected = isExpected;
    }

    /**
     * Whether the termination is expected.
     *
     * @return true if expected otherwise false.
     */
    public boolean isExpected()
    {
        return isExpected;
    }
}