Reasons for session closure.
| Enumerator |
|---|
| SESSION_CLOSE_REASON_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.
|
| SESSION_CLOSE_REASON_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.
|
| SESSION_CLOSE_REASON_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.
|
| SESSION_CLOSE_REASON_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.
|
| SESSION_CLOSE_REASON_CLOSED_BY_CLIENT | The client requested close.
Not recoverable.
|
| SESSION_CLOSE_REASON_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.
|
| SESSION_CLOSE_REASON_INTERNAL_ERROR | An internal error occurred.
An unexpected internal error has occurred. The server logs will contain more detail.
|
| SESSION_CLOSE_REASON_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.
|
| SESSION_CLOSE_REASON_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.
|
| SESSION_CLOSE_REASON_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.
|
| SESSION_CLOSE_REASON_CLOSED_BY_CONTROLLER | Closed by a client session.
A control session initiated the client close.
|
| SESSION_CLOSE_REASON_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
|
| SESSION_CLOSE_REASON_EXPIRED | The session had an EXPIRY_TIME specified which expired before the session re-authenticated.
- Since
- 6.12
|
| SESSION_CLOSE_REASON_REVOKED | The session's authentication was revoked by a privileged user.
- Since
- 6.12
|
| SESSION_CLOSE_REASON_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
|
1.9.8