io.hekate.messaging.MessagingEndpoint Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hekate-core 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;

import io.hekate.cluster.ClusterAddress;
import io.hekate.cluster.ClusterNodeId;

/**
 * Remote messaging endpoint.
 *
 * 
 * This interface provides information about the remote peer of a {@link Message}.
 * 
 *
 * @param  Base type of messages that can be supported by this endpoint.
 *
 * @see Message#endpoint()
 */
public interface MessagingEndpoint {
    /**
     * Returns the address of the remote cluster node.
     *
     * @return Address of the remote cluster node.
     */
    ClusterAddress remoteAddress();

    /**
     * Returns the custom context object that was set via {@link #setContext(Object)}.
     *
     * @return Context object.
     */
    Object getContext();

    /**
     * Sets the custom context object that should be associated with this endpoint.
     *
     * @param ctx Context object.
     */
    void setContext(Object ctx);

    /**
     * Returns the messaging channel of this endpoint.
     *
     * @return Messaging channel.
     */
    MessagingChannel channel();

    /**
     * Returns the universally unique identifier of the remote cluster node.
     *
     * @return Universally unique identifier of the remote cluster node.
     */
    default ClusterNodeId remoteNodeId() {
        return remoteAddress().id();
    }
}