Class McastService

All Implemented Interfaces:
McastServiceMBean, MembershipListener, MembershipService, MessageListener

public class McastService extends Object implements MembershipService, MembershipListener, MessageListener, McastServiceMBean
A membership implementation using simple multicast. This is the representation of a multicast membership service. This class is responsible for maintaining a list of active cluster nodes in the cluster. If a node fails to send out a heartbeat, the node will be dismissed.
  • Field Details

    • sm

      protected static final StringManager sm
      The string manager for this package.
    • properties

      protected Properties properties
      The implementation specific properties
    • impl

      protected McastServiceImpl impl
      A handle to the actual low level implementation
    • listener

      protected volatile MembershipListener listener
      A membership listener delegate (should be the cluster :)
    • msglistener

      protected MessageListener msglistener
      A message listener delegate for broadcasts
    • localMember

      protected MemberImpl localMember
      The local member
    • payload

      protected byte[] payload
    • domain

      protected byte[] domain

      protected static final Member[] EMPTY_MEMBERS
      Return all the members
  • Constructor Details

    • McastService

      public McastService()
      Create a membership service.
  • Method Details

    • setProperties

      public void setProperties(Properties properties)
      Sets the properties for the membership service.
      Specified by:
      setProperties in interface MembershipService
      properties -
      All are required
      1. mcastPort - the port to listen to
      2. mcastAddress - the mcast group address
      4. bindAddress - the bind address if any - only one that can be null
      5. memberDropTime - the time a member is gone before it is considered gone.
      6. mcastFrequency - the frequency of sending messages
      7. tcpListenPort - the port this member listens to
      8. tcpListenHost - the bind address of this member
      IllegalArgumentException - if a property is missing.
    • getProperties

      public Properties getProperties()
      Specified by:
      getProperties in interface McastServiceMBean
      Specified by:
      getProperties in interface MembershipService
      the properties for the configuration used.
    • getLocalMemberName

      public String getLocalMemberName()
      Specified by:
      getLocalMemberName in interface McastServiceMBean
      the local member name
    • getLocalMember

      public Member getLocalMember(boolean alive)
      Description copied from interface: MembershipService
      Get the local member.
      Specified by:
      getLocalMember in interface MembershipService
      alive - true to set the alive time on the local member
      the member object that defines this member
    • setLocalMemberProperties

      public void setLocalMemberProperties(String listenHost, int listenPort, int securePort, int udpPort)
      Description copied from interface: MembershipService
      Sets the local member properties for broadcasting.
      Specified by:
      setLocalMemberProperties in interface MembershipService
      listenHost - Listen to host
      listenPort - Listen to port
      securePort - Use a secure port
      udpPort - Use UDP
    • setAddress

      public void setAddress(String addr)
    • getAddress

      public String getAddress()
      Specified by:
      getAddress in interface McastServiceMBean
    • setMcastBindAddress

      public void setMcastBindAddress(String bindaddr)
    • setBind

      public void setBind(String bindaddr)
    • getBind

      public String getBind()
      Specified by:
      getBind in interface McastServiceMBean
    • setPort

      public void setPort(int port)
    • setRecoveryCounter

      public void setRecoveryCounter(int recoveryCounter)
    • getRecoveryCounter

      public int getRecoveryCounter()
      Specified by:
      getRecoveryCounter in interface McastServiceMBean
    • setRecoveryEnabled

      public void setRecoveryEnabled(boolean recoveryEnabled)
    • getRecoveryEnabled

      public boolean getRecoveryEnabled()
      Specified by:
      getRecoveryEnabled in interface McastServiceMBean
    • setRecoverySleepTime

      public void setRecoverySleepTime(long recoverySleepTime)
    • getRecoverySleepTime

      public long getRecoverySleepTime()
      Specified by:
      getRecoverySleepTime in interface McastServiceMBean
    • setLocalLoopbackDisabled

      public void setLocalLoopbackDisabled(boolean localLoopbackDisabled)
    • getLocalLoopbackDisabled

      public boolean getLocalLoopbackDisabled()
      Specified by:
      getLocalLoopbackDisabled in interface McastServiceMBean
    • getPort

      public int getPort()
      Specified by:
      getPort in interface McastServiceMBean
    • setFrequency

      public void setFrequency(long time)
    • getFrequency

      public long getFrequency()
      Specified by:
      getFrequency in interface McastServiceMBean
    • setMcastDropTime

      public void setMcastDropTime(long time)
    • setDropTime

      public void setDropTime(long time)
    • getDropTime

      public long getDropTime()
      Specified by:
      getDropTime in interface McastServiceMBean
    • hasProperty

      protected void hasProperty(Properties properties, String name)
      Check if a required property is available.
      properties - The set of properties
      name - The property to check for
    • start

      public void start() throws Exception
      Start broadcasting and listening to membership pings
      Specified by:
      start in interface MembershipService
      Exception - if a IO error occurs
    • start

      public void start(int level) throws Exception
      Description copied from interface: MembershipService
      Starts the membership service. If a membership listeners is added the listener will start to receive membership events.
      Specified by:
      start in interface MembershipService
      level - - level MBR_RX starts listening for members, level MBR_TX starts broad casting the server
      Exception - if the service fails to start.
      IllegalArgumentException - if the level is incorrect.
    • stop

      public void stop(int svc)
      Stop broadcasting and listening to membership pings
      Specified by:
      stop in interface MembershipService
      svc - - level MBR_RX stops listening for members, level MBR_TX stops broad casting the server
    • getMembersByName

      public String[] getMembersByName()
      Return all the members by name
      Specified by:
      getMembersByName in interface McastServiceMBean
      Specified by:
      getMembersByName in interface MembershipService
      all members by name
    • findMemberByName

      public Member findMemberByName(String name)
      Return the member by name
      Specified by:
      findMemberByName in interface McastServiceMBean
      Specified by:
      findMemberByName in interface MembershipService
      name - The member name
      the member
    • hasMembers

      public boolean hasMembers()
      has members?
      Specified by:
      hasMembers in interface McastServiceMBean
      Specified by:
      hasMembers in interface MembershipService
      true if the the group contains members
    • getMember

      public Member getMember(Member mbr)
      Description copied from interface: MembershipService
      Retrieve the specified member from the membership.
      Specified by:
      getMember in interface MembershipService
      mbr - The member to retrieve
      the member
    • getMembers

      public Member[] getMembers()
      Specified by:
      getMembers in interface MembershipService
      a list of all the members in the cluster.
    • setMembershipListener

      public void setMembershipListener(MembershipListener listener)
      Add a membership listener, this version only supports one listener per service, so calling this method twice will result in only the second listener being active.
      Specified by:
      setMembershipListener in interface MembershipService
      listener - The listener
    • setMessageListener

      public void setMessageListener(MessageListener listener)
    • removeMessageListener

      public void removeMessageListener()
    • removeMembershipListener

      public void removeMembershipListener()
      Remove the membership listener
      Specified by:
      removeMembershipListener in interface MembershipService
    • memberAdded

      public void memberAdded(Member member)
      Description copied from interface: MembershipListener
      A member was added to the group
      Specified by:
      memberAdded in interface MembershipListener
      member - Member - the member that was added
    • memberDisappeared

      public void memberDisappeared(Member member)
      Callback from the impl when a new member has been received
      Specified by:
      memberDisappeared in interface MembershipListener
      member - The member
      See Also:
    • messageReceived

      public void messageReceived(ChannelMessage msg)
      Description copied from interface: MessageListener
      Receive a message from the IO components in the Channel stack
      Specified by:
      messageReceived in interface MessageListener
      msg - ChannelMessage
    • accept

      public boolean accept(ChannelMessage msg)
      Specified by:
      accept in interface MessageListener
    • broadcast

      public void broadcast(ChannelMessage message) throws ChannelException
      Description copied from interface: MembershipService
      Broadcasts a message to all members.
      Specified by:
      broadcast in interface MembershipService
      message - The message to broadcast
      ChannelException - Message broadcast failed
    • getSoTimeout

      public int getSoTimeout()
      Specified by:
      getSoTimeout in interface McastServiceMBean
    • setSoTimeout

      public void setSoTimeout(int mcastSoTimeout)
    • getTtl

      public int getTtl()
      Specified by:
      getTtl in interface McastServiceMBean
    • getPayload

      public byte[] getPayload()
    • getDomain

      public byte[] getDomain()
      Specified by:
      getDomain in interface McastServiceMBean
    • setTtl

      public void setTtl(int mcastTTL)
    • setPayload

      public void setPayload(byte[] payload)
      Description copied from interface: MembershipService
      Set a payload to be broadcasted with each membership broadcast.
      Specified by:
      setPayload in interface MembershipService
      payload - byte[]
    • setDomain

      public void setDomain(byte[] domain)
      Specified by:
      setDomain in interface MembershipService
    • setDomain

      public void setDomain(String domain)
    • getChannel

      public Channel getChannel()
      Description copied from interface: MembershipService
      Return the channel that is related to this MembershipService
      Specified by:
      getChannel in interface MembershipService
    • setChannel

      public void setChannel(Channel channel)
      Description copied from interface: MembershipService
      Set the channel that is related to this MembershipService
      Specified by:
      setChannel in interface MembershipService
      channel - The channel
    • setDefaults

      protected void setDefaults(Properties properties)
    • main

      public static void main(String[] args) throws Exception
      Simple test program
      args - Command-line arguments
      Exception - If an error occurs