io.hekate.messaging.operation.SubscribeCallback Maven / Gradle / Ivy

Go to download

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

Java library for cluster communications and computing.

There is a newer version: 4.1.3

/*
 * Copyright 2020 The Hekate Project
 *
 * The Hekate Project licenses this file to you 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.hekate.messaging.operation;

/**
 * Callback for a {@link Subscribe} operation.
 *
 * @param  Base type of request message.
 *
 * @see Subscribe#submit(SubscribeCallback)
 */
@FunctionalInterface
public interface SubscribeCallback {
    /**
     * Called when a request operation gets completed either successfully or with an error.
     *
     * 
     * If operation completes with an error then {@code err} parameter will hold the error cause and {@code reply} parameter will be
     * {@code null}. If operation completes successfully then {@code err} parameter will be {@code null} and {@code reply} parameter
     * will hold the reply message.
     * 
     *
     * @param err Error ({@code null} if operation was successful).
     * @param rsp Response part ({@code null} if operation failed).
     */
    void onComplete(Throwable err, ResponsePart rsp);
}