clunk.message-socket — com.github.duanebester/clunk 0.0.39

close-message-socket clj/s

(close-message-socket ms)

closed-by clj/s

(closed-by ms)

The error that closed the connection, if one did and the platform keeps it: Node's socket does, as errored. The JVM fails while connecting instead.

connected? clj/s

(connected? ms)

get-message-socket clj/s

(get-message-socket port host ssl)

Connects; see byte-buffer-socket/get-buffer-socket. ssl is nil, or the TLS settings clunk.tls/connect takes.

handle-backend clj/s

(handle-backend bs)

handle-frontend clj/s

(handle-frontend message)

Builds the bytes for a message, or for a vector of messages sent together.

pause clj/s

(pause {:keys [paused?]})

JS only: stops handling messages until resume. The socket stops reading too if another chunk arrives meanwhile.

resume clj/s

(resume {:keys [buffer-socket paused? drain]})

send! clj/s

(send! ms message)

Writes a frontend message, or a vector of messages, in one write.

start! clj/s

(start! {:keys [buffer-socket paused? drain]} on-message on-chunk-end on-close)

Calls on-message with each backend message, in order, as it arrives, on-chunk-end after the messages of each socket read, and on-close once the connection ends. On the JVM they run on the connection's reader thread, which on-message may block to push back on the server. In JS, they run from the socket's events, and on-message pushes back by calling pause: no more messages are handled until resume.