Enum TransportEvent

java.lang.Object
java.lang.Enum<TransportEvent>
org.simpleframework.transport.TransportEvent
All Implemented Interfaces:
Serializable, Comparable<TransportEvent>, java.lang.constant.Constable

public enum TransportEvent extends Enum<TransportEvent>
The TransportEvent enum represents various events that can occur with the transport. Events that are available here are typically those that refer to low level I/O operations within the server. If a Trace has been associated with the socket connection then it will receive these events as they occur.
  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>
  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    This event occurs when a server challenges for an X509 certificate.
    This event occurs when the underlying connection is terminated.
    This event occurs when there is an error with the transport.
    This event occurs with HTTPS when a new SSL handshake starts.
    This event occurs with HTTPS when a SSL handshake has finished.
    This event indicates that the handshake failed in some way.
    This event represents a read operation on the underlying socket.
    This event occurs when there is no more data available to read.
    This event represents a write operation on the underlying socket.
    This event occurs when a thread must wait for a write to finish.
    This event represents a write buffer operation on the underlying socket.
    This event occurs when no more data can be sent over the socket.
  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
     
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the enum constant of this type with the specified name.
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • READ

      public static final TransportEvent READ
      This event represents a read operation on the underlying socket.
    • READ_WAIT

      public static final TransportEvent READ_WAIT
      This event occurs when there is no more data available to read.
    • WRITE

      public static final TransportEvent WRITE
      This event represents a write operation on the underlying socket.
    • WRITE_BUFFER

      public static final TransportEvent WRITE_BUFFER
      This event represents a write buffer operation on the underlying socket.
    • WRITE_WAIT

      public static final TransportEvent WRITE_WAIT
      This event occurs when no more data can be sent over the socket.
    • WRITE_BLOCKING

      public static final TransportEvent WRITE_BLOCKING
      This event occurs when a thread must wait for a write to finish.
    • HANDSHAKE_BEGIN

      public static final TransportEvent HANDSHAKE_BEGIN
      This event occurs with HTTPS when a new SSL handshake starts.
    • HANDSHAKE_DONE

      public static final TransportEvent HANDSHAKE_DONE
      This event occurs with HTTPS when a SSL handshake has finished.
    • CERTIFICATE_CHALLENGE

      public static final TransportEvent CERTIFICATE_CHALLENGE
      This event occurs when a server challenges for an X509 certificate.
    • HANDSHAKE_FAILED

      public static final TransportEvent HANDSHAKE_FAILED
      This event indicates that the handshake failed in some way.
    • CLOSE

      public static final TransportEvent CLOSE
      This event occurs when the underlying connection is terminated.
    • ERROR

      public static final TransportEvent ERROR
      This event occurs when there is an error with the transport.
  • Constructor Details

    • TransportEvent

      private TransportEvent()
  • Method Details

    • values

      public static TransportEvent[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static TransportEvent valueOf(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:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null