ring.websocket — ring/ring-core 1.11.0-alpha3

Protocols and utility functions for websocket support.

AsyncSocket clj protocol

A protocol for sending data asynchronously via websocket. Intended for use with the Socket protocol.

-send-async clj

(-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.

BinaryData clj protocol

A protocol for converting binary data into a java.nio.ByteBuffer object.

->byte-buffer clj

(->byte-buffer data)

Convert some binary data into a java.nio.ByteBuffer, ready to be sent as a websocket binary message.

close clj

(close socket)

(close socket code reason)

Closes the websocket, with an optional custom integer status code and reason string.

Listener clj protocol

A protocol for handling websocket events. The second argument is always an object that satisfies the Socket protocol.

on-close clj

(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 clj

(on-error listener socket throwable)

Called when a Throwable error is thrown.

on-message clj

(on-message listener socket message)

Called when a message is received. The message may be a String or a ByteBuffer.

on-open clj

(on-open listener socket)

Called when the websocket is opened.

on-pong clj

(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.

open? clj

(open? socket)

Returns true if the Socket is open, false otherwise.

ping clj

(ping socket)

(ping socket data)

Sends a ping message via a websocket, with an optional byte array or ByteBuffer that may contain custom session data. A convenient wrapper for the -ping protocol method.

pong clj

(pong socket)

(pong socket data)

Sends an unsolicited pong message via a websocket, with an optional byte array or ByteBuffer that may contain custom session data. A convenient wrapper for the -pong protocol method.

request-protocols clj

(request-protocols request)

Returns a collection of websocket subprotocols from a request map.

send clj

(send socket message)

(send socket message succeed fail)

Sends text or binary data via a websocket, either synchronously or asynchronously with callback functions. A convenient wrapper for the -send and -send-async protocol methods.

Socket clj protocol

A protocol for sending data via websocket.

-close clj

(-close socket code reason)

Closes the socket with an integer status code, and a String reason.

-open? clj

(-open? socket)

Returns true if the socket is open; false otherwise.

-ping clj

(-ping socket data)

Sends a ping message to the client with a ByteBuffer of extra data.

-pong clj

(-pong socket data)

Sends an unsolicited pong message to the client, with a ByteBuffer of extra data.

-send clj

(-send socket message)

Sends a String or ByteBuffer to the client via the websocket.

TextData clj protocol

A protocol for converting text data into a String.

->string clj

(->string data)

Convert some data into a String, ready to be sent as a websocket text message.

websocket-request? clj

(websocket-request? request)

Returns true if the request map expects a websocket response.

websocket-response? clj

(websocket-response? response)

Returns true if the response contains a websocket listener.