CloseMessage interface
A hub message indicating that the sender is closing the connection. If error is defined, the sender is closing the connection due to an error.
- Extends
Properties
allow |
If true, clients with automatic reconnects enabled should attempt to reconnect after receiving the CloseMessage. Otherwise, they should not. |
error | The error that triggered the close, if any. If this property is undefined, the connection was closed normally and without error. |
type |
Property Details
allowReconnect
If true, clients with automatic reconnects enabled should attempt to reconnect after receiving the CloseMessage. Otherwise, they should not.
allowReconnect?: boolean
Property Value
boolean
error
The error that triggered the close, if any. If this property is undefined, the connection was closed normally and without error.
error?: string
Property Value
string