org.jgroups.Address Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wildfly-client-all

This artifact provides a single jar that contains all classes required to use remote Jakarta Enterprise Beans and Jakarta Messaging, including all dependencies. It is intended for use by those not using maven, maven users should just import the Jakarta Enterprise Beans and Jakarta Messaging BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up with different versions on classes on the class path).

The newest version!


package org.jgroups;

import org.jgroups.util.SizeStreamable;
import org.jgroups.util.UUID;

/**
 * Address identifies cluster member. For example, whenever a unicast message is sent in a cluster
 * an Address of a cluster member message recipient needs to be specified. Similarly a cluster
 * member can use Address to check its own identity, request a state from a particular member and so
 * on. Addresses are mostly generated by the bottom-most (transport) layers (e.g. UDP, TCP,
 * LOOPBACK).
 * 
 * @author Bela Ban
 * @since 2.0
 * @see PhysicalAddress
 * @see UUID
 */
public interface Address extends SizeStreamable, Comparable {
    // flags used for marshalling
    byte NULL         = 1 << 0;
    byte UUID_ADDR    = 1 << 1;
    byte SITE_UUID    = 1 << 2;
    byte SITE_MASTER  = 1 << 3;
    byte IP_ADDR      = 1 << 4;

    /**
     * Whether or not this address causes a message to be sent to mulitple members. Typically, 'null' as destination
     * sends the message to all members of a cluster, and a non-null address sends it to a single member. However, if
     * a non-null destination address causes multicast behavior, this method needs to return true.
     * @return True if a message with this address as destination is sent to multiple members, else false
     */
    default boolean isMulticast()   {return false;}

    /**
     * Whether or not this address is a {@link org.jgroups.protocols.relay.SiteAddress}. Kludgey workaround to avoid
     * the use of {@code instanceof SiteAddress}.

     * Will be removed once the type pollution issue (https://bugs.openjdk.org/browse/JDK-8180450) is fixed.
     * @return True if this address is a site address, otherwise false
     */
    default boolean isSiteAddress() {return false;}

    /**
     * Whether or not this address is a {@link org.jgroups.protocols.relay.SiteMaster}. Kludgey workaround to avoid
     * the use of {@code instanceof SiteMaster}.

     * Will be removed once the type pollution issue (https://bugs.openjdk.org/browse/JDK-8180450) is fixed.
     * @return true if this address is a site master, false otherwise
     */
    default boolean isSiteMaster() {return false;}
}