Class JGroupsBroadcastEndpoint

    • Constructor Detail

      • JGroupsBroadcastEndpoint

        public JGroupsBroadcastEndpoint​(JChannelManager manager,
                                        java.lang.String channelName)
    • Method Detail

      • broadcast

        public void broadcast​(byte[] data)
                       throws java.lang.Exception
        Description copied from interface: BroadcastEndpoint
        Broadcasting data to the cluster.
        Specified by:
        broadcast in interface BroadcastEndpoint
        Parameters:
        data - : a byte array containing the data.
        Throws:
        java.lang.Exception
      • receiveBroadcast

        public byte[] receiveBroadcast()
                                throws java.lang.Exception
        Description copied from interface: BroadcastEndpoint
        Receives the broadcast data. It blocks until data is available.
        Specified by:
        receiveBroadcast in interface BroadcastEndpoint
        Returns:
        the received data as byte array.
        Throws:
        java.lang.Exception
      • receiveBroadcast

        public byte[] receiveBroadcast​(long time,
                                       java.util.concurrent.TimeUnit unit)
                                throws java.lang.Exception
        Description copied from interface: BroadcastEndpoint
        Receives the broadcast data with a timeout. It blocks until either the data is available or the timeout is reached, whichever comes first.
        Specified by:
        receiveBroadcast in interface BroadcastEndpoint
        Parameters:
        time - : how long the method should wait for the data to arrive.
        unit - : unit of the time.
        Returns:
        a byte array if data is arrived within the timeout, or null if no data is available after the timeout.
        Throws:
        java.lang.Exception
      • openClient

        public void openClient()
                        throws java.lang.Exception
        Description copied from interface: BroadcastEndpoint
        This method initializes a BroadcastEndpoint as a receiving end for broadcasts. After that data can be received using one of its receiveBroadcast() methods.
        Specified by:
        openClient in interface BroadcastEndpoint
        Throws:
        java.lang.Exception
      • openBroadcaster

        public void openBroadcaster()
                             throws java.lang.Exception
        Description copied from interface: BroadcastEndpoint
        This method initializes a BroadcastEndpint as a broadcaster. After that data can be sent via its broadcast() method.
        Specified by:
        openBroadcaster in interface BroadcastEndpoint
        Throws:
        java.lang.Exception
      • createChannel

        public abstract org.jgroups.JChannel createChannel()
                                                    throws java.lang.Exception
        Throws:
        java.lang.Exception
      • internalOpen

        protected void internalOpen()
                             throws java.lang.Exception
        Throws:
        java.lang.Exception
      • close

        public void close​(boolean isBroadcast)
                   throws java.lang.Exception
        Description copied from interface: BroadcastEndpoint
        Close the endpoint. Any related resources should be cleaned up in this method.
        Specified by:
        close in interface BroadcastEndpoint
        Parameters:
        isBroadcast - : indicates whether this endpoint serves as a broadcast or not.
        Throws:
        java.lang.Exception
      • internalCloseChannel

        protected void internalCloseChannel​(JChannelWrapper channel)
        Closes the channel used in this JGroups Broadcast. Can be overridden by implementations that use an externally managed channel.
        Parameters:
        channel -