io.hekate.messaging.MessageReceiver 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;

/**
 * Message receiver.
 *
 * 
 * This interface represents a receiver that can be registered to the {@link MessagingChannel}
 * (via {@link MessagingChannelConfig#setReceiver(MessageReceiver)} method) in order to receive messages from remote nodes.
 * 
 *
 * 
 * For more details about messaging please see the documentation of {@link MessagingService} interface.
 * 
 *
 * @param  Base type of messages that can be handled by this receiver.
 *
 * @see MessagingChannelConfig#setReceiver(MessageReceiver)
 * @see MessagingService
 */
@FunctionalInterface
public interface MessageReceiver {
    /**
     * Called when a new message is received by this channel.
     *
     * @param msg Message.
     */
    void receive(Message msg);

    /**
     * Called when a remote node connects to this channel.
     *
     * @param endpoint Connected endpoint.
     */
    default void onConnect(MessagingEndpoint endpoint) {
        // No-op.
    }

    /**
     * Called when a remote node disconnects from this channel.
     *
     * @param endpoint Disconnected endpoint.
     */
    default void onDisconnect(MessagingEndpoint endpoint) {
        // No-op.
    }
}