com.lightbend.lagom.scaladsl.api.transport
TransportErrorCode
Related Docs:
object TransportErrorCode
| package transport
com.lightbend.lagom.scaladsl.api.transport
A description of this close code.
A description of this close code.
This description will be meaningful for known built in close codes, but for other codes, it will be
Unknown error code
A description of this closed code.
The HTTP status code for this error.
The WebSocket close code for this error.
An error code that gets translated into an appropriate underlying error code.
This attempts to match up corresponding HTTP error codes with WebSocket close codes, so that user code can generically select a code without worrying about the underlying transport.
While most WebSocket close codes that we typically use do have a corresponding HTTP error code, there are many HTTP error codes that don't have a corresponding WebSocket close code. In these cases, we use the private WebSocket close code range (4xxx), with the HTTP error code as the last three digits. Such WebSocket close codes will be in the range 4400 to 4599.
This class should only be used to represent error codes, status codes like HTTP 200 should not be represented using this class. This is enforced for HTTP codes, since they have a well defined categorisation, codes between 400 and 599 are considered errors. It is however not enforced for WebSockets, since the WebSocket protocol defines no such categorisation of codes, it specifies a number of well known codes from 1000 to 1015, with no particular pattern to their meaning, and the remaining codes are only categorised by whether they are private, reserved for the WebSocket spec, or reserved for applications to specify.
For WebSocket close codes that are not known, or are not in the private range of 4400 to 4599 defined by us, this use class uses the generic HTTP 404 error code.