The name used by Clients for targeting the Socket
General Properties
The WebSocket or URL that will be wrapped by the SocketWrapper
General Properties
The TocketClient this SocketWrapper is registered to.
General Properties
Optional timeout: numberThe number of Milliseconds this socket will wait for responses form other endpoints.
General Properties
true* If the WebSocket connection should be initialized immediately,
General Properties
Smarkand. Funnelly
General Properties
If logging is enabled all intercepted messages will be stored here
Utility function for checking if a socket is alive.
true if the socket is alive, false if it isn't
Inbound transformation object, converts input from the webSocket into valid SocketRequests
Outbound transformation object, applied to the SocketRequest just before it is sent.
Main method for sending messages over the connected Socket.
Protected delayedThe [source]
The name used by Clients for targeting the Socket
Protected initializedtrue* If the WebSocket connection should be initialized immediately,
Smarkand. Funnelly
The number of times the SocketWrapper will try to reconnect to a WebSocket after the connection is lost.
Readonly registrationThe TocketClient this SocketWrapper is registered to.
How long to wait between each connection attempt
Protected sourceThe WebSocket or URL that will be wrapped by the SocketWrapper
Optional timeoutThe number of Milliseconds this socket will wait for responses form other endpoints.
Private getPrivate initiatePrivate modifyPrivate Readonly replacedMap of WebSocket properties and methods that have been replaced by Tocket
Private retriesThe current number of times the socket has failed to connect to the [source]
Generated using TypeDoc
The SocketWrapper acts as an interface to interact with the actual socket, with a focus on managing builtin WebSocket methods while injecting functionality required by Tocket.
This includes timeout and retry settings and logs of messages sent and received by the socket as well as methods for transforming input and output messages from a Tocket readable format to formats required by a third party WebSocket and vice versa.