io.axoniq.axonserver.connector.impl.ReconnectConfiguration Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2020. AxonIQ
 *
 * 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
 *
 *    http://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.axoniq.axonserver.connector.impl;

import java.util.concurrent.TimeUnit;

/**
 * Container of configuration variables used when reconnecting to a channel.
 */
public class ReconnectConfiguration {

    private final long connectTimeout;
    private final long reconnectInterval;
    private final boolean forcePlatformReconnect;
    private final TimeUnit timeUnit;

    /**
     * Construct a new {@link ReconnectConfiguration}.
     *
     * @param connectTimeout         a {@code long} defining the connect timeout
     * @param reconnectInterval      a {@code long} defining the interval when to reconnect
     * @param forcePlatformReconnect a {@code boolean} defining whether a platform reconnect should be enforced
     * @param timeUnit               the {@link TimeUnit} used for both the {@code connectTimeout} and {@code
     *                               reconnectInterval}
     */
    public ReconnectConfiguration(long connectTimeout,
                                  long reconnectInterval,
                                  boolean forcePlatformReconnect,
                                  TimeUnit timeUnit) {
        this.connectTimeout = connectTimeout;
        this.reconnectInterval = reconnectInterval;
        this.forcePlatformReconnect = forcePlatformReconnect;
        this.timeUnit = timeUnit;
    }

    /**
     * Return the configured connect timeout.
     *
     * @return the configured connect timeout
     */
    public long getConnectTimeout() {
        return connectTimeout;
    }

    /**
     * Return the configured reconnect timeout.
     *
     * @return the configured reconnect timeout
     */
    public long getReconnectInterval() {
        return reconnectInterval;
    }

    /**
     * Return whether a platform reconnect should be enforced.
     *
     * @return whether a platform reconnect should be enforced
     */
    public boolean isForcePlatformReconnect() {
        return forcePlatformReconnect;
    }

    /**
     * Return the configured {@link TimeUnit} used by {@link #getConnectTimeout()} and {@link #getReconnectInterval()}.
     *
     * @return the configured {@link TimeUnit} used by {@link #getConnectTimeout()} and {@link #getReconnectInterval()}
     */
    public TimeUnit getTimeUnit() {
        return timeUnit;
    }
}