Package org.metricshub.ipmi.core.sm

Class StateMachine

java.lang.Object
org.metricshub.ipmi.core.sm.StateMachine
All Implemented Interfaces:
UdpListener
public class StateMachine extends Object implements UdpListener
State machine for connecting and acquiring session with the remote host via IPMI v.2.0.

  • Constructor Details

  • Method Details

    • getCurrent

      public State getCurrent()

    • setCurrent

      public void setCurrent(State current)

    • sendMessage

      public void sendMessage(byte[] message) throws IOException
      Sends message via messenger to the managed system.
      Parameters:
      message - - the encoded message
      Throws:
      IOException - - when sending of the message fails

    • getRemoteMachineAddress

      public InetAddress getRemoteMachineAddress()

    • getRemoteMachinePort

      public int getRemoteMachinePort()

    • doExternalAction

      public void doExternalAction(StateMachineAction action)
      Sends a notification of an action to all MachineObservers. A MessageAction emitted by a state while the lock is held is deferred until the transition releases it; the other actions are published at once.
      Parameters:
      action - - a StateMachineAction to perform

    • start

      public void start(InetAddress address, int port)
      Sets the State Machine in the initial state.
      Parameters:
      address - - IP address of the remote machine.
      port - - UDP remoteMachinePort of the remote machine
      See Also:

    • stop

      public void stop()
      Cleans up the machine resources and leaves the current state: a stopped machine no longer reports a valid session.
      See Also:

    • isActive

      public boolean isActive()
      Returns:
      true if StateMachine is initialized, false otherwise.
      See Also:

    • doTransition

      public void doTransition(StateMachineEvent event)
      Performs a State transition according to the event and current state. Transitions and received messages are serialized, so a late reply cannot interleave with the timeout or close of the request it answers; the in-session messages are dispatched once the lock is released.
      Parameters:
      event - - StateMachineEvent invoking the transition
      Throws:
      NullPointerException - - when machine was not yet started
      See Also:

    • notifyMessage

      public void notifyMessage(UdpMessage message)
      Description copied from interface: UdpListener
      Notifies listener of the UDP message that was received.
      Specified by:
      notifyMessage in interface UdpListener
      Parameters:
      message - - message received

    • register

      public void register(MachineObserver observer)
      Registers the listener in the StateMachine so it will be notified of the StateMachineActions performed via doExternalAction(StateMachineAction)
      Parameters:
      observer - - MachineObserver to register