tuddman/socketcluster-clj

A SocketCluster Client library for Clojure.

socketcluster-clj

A SocketCluster Client library for Clojure. This client wraps socketcluster-client-java, but where appropriate aims to be more idiomatic and succinct.

Usage

lein repl

;; define
=> (require '[socketcluster-clj.client :as sc-client])
=> (require '[socketcluster-clj.listeners :as sc-listen])
=> (require '[socketcluster-clj.events :as sc-event])
=> (require '[socketcluster-clj.channels :as sc-ch])
=> (def sc-server-url "ws://localhost:8000/socketcluster/")
=> (def my-socket (sc-client/new-socket sc-server-url)  
or
=> (sc-client/set-url my-socket sc-server-url)

;; set listener(s)
=> (sc-listen/set-listener my-socket)

;; connect
=> (sc-client/connect my-socket)
;; automatically re-connect
=> (sc-client/set-reconnect-strategy my-socket 2000 30)

;; send event(s) to the server
=> (sc-event/emit my-socket {"some" "data"})

;; CHANNELS -

;; subscribe

=> (sc-ch/create-channel my-socket "channel-name")
=> (sc-ch/set-channel-listener my-socket "channel-name" (fn [name data] (print "received on channel => " name "some data => " data)))
=> (sc-ch/subscribe my-socket "channel-name")

;; publish
=> (sc-ch/publish my-socket "channel-name" {"some" "data"})

for more, have a look in src/socketcluster_clj/<ns>.clj to learn what else you can call.

NPE Issue

if you get the following error when trying to connect:

Exception in thread "OkHttp Dispatcher" java.lang.NullPointerException
	at io.github.sac.Socket$1.onFailure(Socket.java:185)
	at okhttp3.internal.ws.RealWebSocket.failWebSocket(RealWebSocket.java:546)
	at okhttp3.internal.ws.RealWebSocket$2.onResponse(RealWebSocket.java:206)

you need to (sc-listen/set-listener <socket>) before connecting.

License

Copyright © 2019 tuddman

This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at http://www.eclipse.org/legal/epl-2.0.

This Source Code may also be made available under the following Secondary Licenses when the conditions for such availability set forth in the Eclipse Public License, v. 2.0 are satisfied: GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version, with the GNU Classpath Exception which is available at https://www.gnu.org/software/classpath/license.html.

socketcluster-clj's Issues

Issue with requiring define-ack

 (ns socketcluster-clj.events
   (:require
     [socketcluster-clj.listeners :refer [define-listener define-ack-listener]]))

Misses define-ack
Also socketcluster-clj.channels
I don't know why does it work in your example, but with this error I couldn't import your library.

 (ns socketcluster-clj.events
   (:require
     [socketcluster-clj.listeners :refer [define-listener define-ack-listener define-ack]]))