Package deltix.util.vsocket

Enum VSChannelState

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<VSChannelState>
    public enum VSChannelState
extends java.lang.Enum<VSChannelState>
    Date: Mar 30, 2010

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      Closed
      Local endpoint has been closed.
      Connected
      Normal connected state.
      NotConnected
      Just created no handshake yet.
      RemoteClosed
      Remote endpoint has been closed.
      Removed
      Local close has been confirmed by remote side; therefore its id can now be re-used.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static VSChannelState valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static VSChannelState[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • NotConnected

        public static final VSChannelState NotConnected
        Just created no handshake yet. Writing to output stream is possible, but might block waiting for handshake (with remote capacity report). Reading from input stream will obviously block waiting for data to be sent over.

      • Connected

        public static final VSChannelState Connected
        Normal connected state.

      • RemoteClosed

        public static final VSChannelState RemoteClosed
        Remote endpoint has been closed. Writing to output stream will result in a ChannelClosedException being thrown. Reading from input stream will return all data that was sent prior to remote endpoint being closed, then EOF.

      • Removed

        public static final VSChannelState Removed
        Local close has been confirmed by remote side; therefore its id can now be re-used. To the caller, this state's behavior is identical to Closed.

    • Method Detail

      • values

        public static VSChannelState[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (VSChannelState c : VSChannelState.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static VSChannelState valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null