io.axoniq.axonserver.connector.impl.HeartbeatSender 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 io.axoniq.axonserver.grpc.InstructionAck;

import java.util.concurrent.CompletableFuture;

/**
 * Functional interface defining a method to send heartbeats with.
 */
@FunctionalInterface
public interface HeartbeatSender {

    /**
     * Send a heartbeat, receiving a {@link CompletableFuture} containing the {@link InstructionAck} once the heartbeat
     * has been received.
     *
     * @return a {@link CompletableFuture} containing the {@link InstructionAck} once the heartbeat has been received
     */
    CompletableFuture sendHeartbeat();
}