Package com.pushtechnology.diffusion.client.features.control.clients

Enum Class ClientControl.CloseReason

java.lang.Object
java.lang.Enum<ClientControl.CloseReason>
com.pushtechnology.diffusion.client.features.control.clients.ClientControl.CloseReason
All Implemented Interfaces:
Serializable, Comparable<ClientControl.CloseReason>, Constable
Enclosing interface:
ClientControl
public static enum ClientControl.CloseReason extends Enum<ClientControl.CloseReason>
The server's view of why a client session was closed.

  • Enum Constant Details

    • CONNECTION_LOST

      public static final ClientControl.CloseReason CONNECTION_LOST
      The connection to the client was lost - possibly dropped by the client. Recoverable.

      A client may be closed for many reasons that are presented as CONNECTION_LOST.

      During connection the connection can be lost. The server might have received a connection or reconnection request from a client already connected. The server might have received a reconnection request without a session Id. The connection may not have been authorised because the credentials are wrong. The maximum number of clients might already be connected.

      Once connected the connection can be lost for different reasons. If the client closes its connection while the server is writing a message to the client. With the chunked encoding based connection the HTTP response is completed by the server. If the client does not open a new request within a timeout the client will be closed. If a poll request times out and the server finds that the connection has already been closed by the client.

    • IO_EXCEPTION

      public static final ClientControl.CloseReason IO_EXCEPTION
      An unexpected IO Exception occurred. Recoverable.

      While trying to perform an I/O operation an exception was generated. This often means that a read was attempted from a closed TCP connection.

      When handling SSL connections if there is a problem encrypting or decrypting a message the client will be closed for this reason.

    • CLIENT_UNRESPONSIVE

      public static final ClientControl.CloseReason CLIENT_UNRESPONSIVE
      The client had become unresponsive.

      The client has either failed to respond to a ping message in a timely manner or the client has failed to open an HTTP poll for messages. The client does not appear to be receiving messages.

    • MESSAGE_QUEUE_LIMIT_REACHED

      public static final ClientControl.CloseReason MESSAGE_QUEUE_LIMIT_REACHED
      The maximum outbound queue size was reached for the client. Not recoverable.

      Messages sent to the client are placed in a queue. This queue has a maximum allowed size. If the queue limit is reached the client is closed and the queue discarded. The queue is intended to protect against slow consumers, reaching the queue limit is taken to mean that the client cannot keep up with the number of messages sent to it.

    • CLOSED_BY_CLIENT

      public static final ClientControl.CloseReason CLOSED_BY_CLIENT
      The client requested close. Not recoverable.

    • MESSAGE_TOO_LARGE

      public static final ClientControl.CloseReason MESSAGE_TOO_LARGE
      The client sent a message that exceeded the maximum message size that can be processed by the server.

      The server has a maximum message size that it can process on any single connector. If a client sends a message larger than this the server is unable to process it. When this happens the message is discarded and the client is closed.

    • INTERNAL_ERROR

      public static final ClientControl.CloseReason INTERNAL_ERROR
      An internal error occurred.

      An unexpected internal error has occurred. The server logs will contain more detail.

    • INVALID_INBOUND_MESSAGE

      public static final ClientControl.CloseReason INVALID_INBOUND_MESSAGE
      An inbound message with an invalid format was received.

      A message received by the server is not a valid Diffusion message. The server is unable to process this and closes the client that sent it.

    • ABORTED

      public static final ClientControl.CloseReason ABORTED
      The client connection was aborted by the server, possibly because the connection was disallowed.

      This is may be because the connection was disallowed. Abort messages are also sent to clients that have unrecognised client IDs. This may be because the server closed the client previously but the client is unaware of this and tried to continue interacting with the server.

    • LOST_MESSAGES

      public static final ClientControl.CloseReason LOST_MESSAGES
      Loss of messages from the client has been detected. For example, whilst waiting for the arrival of missing messages in a sequence of messages a timeout has occurred.

      HTTP based transports use multiple TCP connections. This can cause the messages to be received out of order. To reorder the messages those sent to the server may contain a sequence number indicating the correct order.

      If a message is received out of order there is a short time for the earlier messages to be received. If the messages are not received in this time the client is closed.

      Missing, invalid or duplicate sequence numbers will also close the client for this reason.

      This cannot be recovered from as the client and the server are in inconsistent states.

    • CLOSED_BY_CONTROLLER

      public static final ClientControl.CloseReason CLOSED_BY_CONTROLLER
      Closed by a client session.

      A control session initiated the client close.

    • FAILED_OVER

      public static final ClientControl.CloseReason FAILED_OVER
      The session has failed over to a different Diffusion server.

      The session is still open but is now connected to a different Diffusion server. This server has evicted its view of the session from its set of local sessions.

      Since:
      5.8

    • EXPIRED

      public static final ClientControl.CloseReason EXPIRED
      The session had an Session.EXPIRY_TIME specified which expired before the session re-authenticated.
      Since:
      6.12

    • REVOKED

      public static final ClientControl.CloseReason REVOKED
      The session's authentication was revoked by a privileged user.
      Since:
      6.12

    • SESSION_TAKEN_OVER

      public static final ClientControl.CloseReason SESSION_TAKEN_OVER
      The session has been closed to make way for a new session.

      This can only occur for an MQTT session.

      Since:
      6.12

  • Method Details

    • values

      public static ClientControl.CloseReason[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static ClientControl.CloseReason valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null