ring.websocket.protocols
AsyncSocket
protocol
A protocol for sending data asynchronously via websocket. Intended for use with the Socket protocol.
members
-send-async
(-send-async socket message succeed fail)Sends a String or ByteBuffer to the client via the websocket. If it succeeds, the 'succeed' callback function is called with zero arguments. If it fails, the 'fail' callback function is called with the exception that was thrown.
Listener
protocol
A protocol for handling websocket events. The second argument is always an object that satisfies the Socket protocol.
members
on-close
(on-close listener socket code reason)Called when the websocket is closed, along with an integer code and a plaintext string reason for being closed.
on-error
(on-error listener socket throwable)Called when a Throwable error is thrown.
on-message
(on-message listener socket message)Called when a message is received. The message may be a String or a ByteBuffer.
on-open
(on-open listener socket)Called when the websocket is opened.
on-pong
(on-pong listener socket data)Called when a pong is received in response to an earlier ping. The client may provide additional binary data, represented by the data ByteBuffer.
PingListener
protocol
A protocol for handling ping websocket events. The second argument is always always an object that satisfies the Socket protocol. This is separate from the Listener protocol as some APIs (for example Jakarta) don't support listening for ping events.
members
on-ping
(on-ping listener socket data)Called when a ping is received from the client. The client may provide additional binary data, represented by the data ByteBuffer.
Socket
protocol
A protocol for sending data via websocket.
members
-close
(-close socket code reason)Closes the socket with an integer status code, and a String reason.
-open?
(-open? socket)Returns true if the socket is open; false otherwise.
-ping
(-ping socket data)Sends a ping message to the client with a ByteBuffer of extra data.
-pong
(-pong socket data)Sends an unsolicited pong message to the client, with a ByteBuffer of extra data.
-send
(-send socket message)Sends a String or ByteBuffer to the client via the websocket.