Package org.jgroups.protocols

Class RELAY

  • @Deprecated
public class RELAY
extends Protocol
    Deprecated.
    Use RELAY2 instead
    Simple relaying protocol: RELAY is added to the top of the stack, creates a channel to a bridge cluster, and - if coordinator - relays all multicast messages via the bridge cluster to the remote cluster.

    This is not a big virtual cluster, e.g. consisting of {A,B,C,X,Y,Z}, but 2 autonomous clusters {A,B,C} and {X,Y,Z}, bridged together by RELAY. For example, when B multicasts a message M, A (if it happens to be the coord) relays M to X (which happens to be the other cluster's coordinator). X then re-broadcasts M, with M.src being a ProxyUUID(X,B). This means that the sender of M in the {X,Y,Z} cluster will be X for all practical purposes, but the original sender B is also recorded, for sending back a response.

    See [1] and [2] for details.

    [1] https://jira.jboss.org/browse/JGRP-747

    [2] doc/design/RELAY.txt

    Since:
    2.12
    Author:
    Bela Ban

    • Field Detail

      • site

        protected java.lang.String site
        Deprecated.

      • bridge_props

        protected java.lang.String bridge_props
        Deprecated.

      • bridge_name

        protected java.lang.String bridge_name
        Deprecated.

      • relay

        protected boolean relay
        Deprecated.

      • present_global_views

        protected boolean present_global_views
        Deprecated.

      • local_addr

        protected Address local_addr
        Deprecated.

      • is_coord

        protected volatile boolean is_coord
        Deprecated.

      • coord

        protected volatile Address coord
        Deprecated.

      • bridge

        protected JChannel bridge
        Deprecated.
        The bridge between the two local clusters, usually based on a TCP config

      • local_view

        protected View local_view
        Deprecated.
        The view of the local cluster

      • bridge_view

        protected View bridge_view
        Deprecated.
        The view of the bridge cluster, usually consists of max 2 nodes

      • remote_view

        protected View remote_view
        Deprecated.
        The view of the remote cluster

      • global_view

        protected View global_view
        Deprecated.
        The combined view of local and remote cluster

      • global_view_id

        protected long global_view_id
        Deprecated.
        To generate new global views

      • remote_view_fetcher_future

        protected java.util.concurrent.Future<?> remote_view_fetcher_future
        Deprecated.

      • bridge_creator

        protected java.util.function.Function<java.lang.String,​JChannel> bridge_creator
        Deprecated.

      • SITE_ID

        protected static final byte[] SITE_ID
        Deprecated.

    • Constructor Detail

      • RELAY

        public RELAY()
        Deprecated.

    • Method Detail

      • setRelay

        public void setRelay​(boolean relay)
        Deprecated.

      • getLocalView

        public java.lang.String getLocalView()
        Deprecated.

      • getBridgeView

        public java.lang.String getBridgeView()
        Deprecated.

      • getRemoteView

        public java.lang.String getRemoteView()
        Deprecated.

      • getGlobalView

        public java.lang.String getGlobalView()
        Deprecated.

      • getBridgeCreator

        public java.util.function.Function<java.lang.String,​JChannel> getBridgeCreator()
        Deprecated.

      • setBridgeCreator

        public RELAY setBridgeCreator​(java.util.function.Function<java.lang.String,​JChannel> bc)
        Deprecated.

      • init

        public void init()
          throws java.lang.Exception
        Deprecated.
        Description copied from class: Protocol
        Called after instance has been created (null constructor) and before protocol is started. Properties are already set. Other protocols are not yet connected and events cannot yet be sent.
        Overrides:
        init in class Protocol
        Throws:
        java.lang.Exception - Thrown if protocol cannot be initialized successfully. This will cause the ProtocolStack to fail, so the channel constructor will throw an exception

      • stop

        public void stop()
        Deprecated.
        Description copied from class: Protocol
        This method is called on a JChannel.disconnect(). Stops work (e.g. by closing multicast socket). Will be called from top to bottom. This means that at the time of the method invocation the neighbor protocol below is still working. This method will replace the STOP, STOP_OK, CLEANUP and CLEANUP_OK events. The ProtocolStack guarantees that when this method is called all messages in the down queue will have been flushed
        Overrides:
        stop in class Protocol

      • down

        public java.lang.Object down​(Event evt)
        Deprecated.
        Description copied from class: Protocol
        An event is to be sent down the stack. A protocol may want to examine its type and perform some action on it, depending on the event's type. If the event is a message MSG, then the protocol may need to add a header to it (or do nothing at all) before sending it down the stack using down_prot.down().
        Overrides:
        down in class Protocol

      • down

        public java.lang.Object down​(Message msg)
        Deprecated.
        Description copied from class: Protocol
        A message is sent down the stack. Protocols may examine the message and do something (e.g. add a header) with it before passing it down.
        Overrides:
        down in class Protocol

      • up

        public java.lang.Object up​(Event evt)
        Deprecated.
        Description copied from class: Protocol
        An event was received from the protocol below. Usually the current protocol will want to examine the event type and - depending on its type - perform some computation (e.g. removing headers from a MSG event type, or updating the internal membership list when receiving a VIEW_CHANGE event). Finally the event is either a) discarded, or b) an event is sent down the stack using down_prot.down() or c) the event (or another event) is sent up the stack using up_prot.up().
        Overrides:
        up in class Protocol

      • up

        public java.lang.Object up​(Message msg)
        Deprecated.
        Description copied from class: Protocol
        A single message was received. Protocols may examine the message and do something (e.g. add a header) with it before passing it up.
        Overrides:
        up in class Protocol

      • up

        public void up​(MessageBatch batch)
        Deprecated.
        Description copied from class: Protocol
        Sends up a multiple messages in a MessageBatch. The sender of the batch is always the same, and so is the destination (null == multicast messages). Messages in a batch can be OOB messages, regular messages, or mixed messages, although the transport itself will create initial MessageBatches that contain only either OOB or regular messages.

        The default processing below sends messages up the stack individually, based on a matching criteria (calling Protocol.accept(org.jgroups.Message)), and - if true - calls Protocol.up(org.jgroups.Event) for that message and removes the message. If the batch is not empty, it is passed up, or else it is dropped.

        Subclasses should check if there are any messages destined for them (e.g. using MessageBatch.getMatchingMessages(short,boolean)), then possibly remove and process them and finally pass the batch up to the next protocol. Protocols can also modify messages in place, e.g. ENCRYPT could decrypt all encrypted messages in the batch, not remove them, and pass the batch up when done.

        Overrides:
        up in class Protocol
        Parameters:
        batch - The message batch

      • handleView

        protected void handleView​(View view)
        Deprecated.

      • installView

        protected java.lang.Object installView​(byte[] buf,
                                       int offset,
                                       int length)
        Deprecated.

      • forward

        protected void forward​(byte[] buffer,
                       int offset,
                       int length)
        Deprecated.
        Forwards the message across the TCP link to the other local cluster

      • forwardToCoord

        protected void forwardToCoord​(Message msg)
        Deprecated.
        Wraps the message annd sends it to the current coordinator

      • sendViewToRemote

        protected void sendViewToRemote​(RELAY.ViewData view_data,
                                boolean use_seperate_thread)
        Deprecated.

      • generateGlobalView

        protected View generateGlobalView​(View local_view,
                                  View remote_view)
        Deprecated.

      • generateGlobalView

        protected View generateGlobalView​(View local_view,
                                  View remote_view,
                                  boolean merge)
        Deprecated.

      • createBridge

        protected void createBridge()
        Deprecated.

      • sendOnLocalCluster

        protected void sendOnLocalCluster​(byte[] buf,
                                  int offset,
                                  int length)
        Deprecated.

      • sendViewOnLocalCluster

        protected void sendViewOnLocalCluster​(View remote_view,
                                      View global_view,
                                      boolean use_seperate_thread,
                                      java.util.List<Address> new_mbrs)
        Deprecated.

      • sendViewOnLocalCluster

        protected void sendViewOnLocalCluster​(RELAY.ViewData data,
                                      boolean use_seperate_thread,
                                      java.util.List<Address> new_mbrs)
        Deprecated.

      • sendViewOnLocalCluster

        protected void sendViewOnLocalCluster​(java.util.List<Address> destinations,
                                      byte[] buffer)
        Deprecated.

      • isLocal

        protected boolean isLocal​(Address dest)
        Deprecated.
        Does the payload match the 'site' ID. Checks only unicast destinations (multicast destinations return true)

      • startRemoteViewFetcher

        protected void startRemoteViewFetcher()
        Deprecated.

      • stopRemoteViewFetcher

        protected void stopRemoteViewFetcher()
        Deprecated.