Interface Fiber

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int RUNNING
      This state is used to define the normal runtime condition of a Fiber.
      static int START_PENDING
      This is the initial Fiber state.
      static int STARTING
      This state is used to define when a Fiber has begun the Initialization process.
      static String[] STATUS_NAMES
      The string names that correspond to the states of the fiber.
      static int STOP_PENDING
      This state is used to denote when the Fiber is terminating processing.
      static int STOPPED
      This state represents the final resting state of a Fiber.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getName()
      This method is used to return the name of the Fiber.
      int getStatus()
      This method is used to get the current status of the Fiber.
      void start()
      This method is used to start the initialization process of the Fiber, which should eventually transition to a RUNNING status.
      void stop()
      This method is used to stop a currently running Fiber.
    • Field Detail

      • STATUS_NAMES

        static final String[] STATUS_NAMES
        The string names that correspond to the states of the fiber.
      • START_PENDING

        static final int START_PENDING
        This is the initial Fiber state. When the Fiber begins it startup process it will transition to the STARTING state. A Fiber in a start pending state has not begun any of the initialization process.
        See Also:
        Constant Field Values
      • STARTING

        static final int STARTING
        This state is used to define when a Fiber has begun the Initialization process. Once the initialization process is completed the Fiber will transition to a RUNNING status.
        See Also:
        Constant Field Values
      • RUNNING

        static final int RUNNING
        This state is used to define the normal runtime condition of a Fiber. When a Fiber is in this state then it is processing normally.
        See Also:
        Constant Field Values
      • STOP_PENDING

        static final int STOP_PENDING
        This state is used to denote when the Fiber is terminating processing. This state is always followed by the state ST0PPED.
        See Also:
        Constant Field Values
      • STOPPED

        static final int STOPPED
        This state represents the final resting state of a Fiber. Depending on the implementation it may be possible to resurrect the Fiber from this state.
        See Also:
        Constant Field Values
    • Method Detail

      • start

        void start()
        This method is used to start the initialization process of the Fiber, which should eventually transition to a RUNNING status.
      • stop

        void stop()
        This method is used to stop a currently running Fiber. Once invoked the Fiber should begin it's shutdown process. Depending on the implementation, this method may block until the Fiber terminates.
      • getName

        String getName()
        This method is used to return the name of the Fiber. The name of the instance is defined by the implementor, but it should be realitively unique when possible.
        Returns:
        The name of the Fiber.
      • getStatus

        int getStatus()
        This method is used to get the current status of the Fiber. The status of the fiber should be one of the predefined constants of the Fiber interface, or from one of the derived interfaces.
        Returns:
        The current status of the Fiber.