wibisono/clj-socketio-client

Clojure wrapper for socketio/socket.io-client-java

Download

Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.wibisono:clj-socketio-client:0.1.1-SNAPSHOT'
	}

	dependencies {
		implementation("com.github.wibisono:clj-socketio-client:0.1.1-SNAPSHOT")
	}

	<dependency>
	    <groupId>com.github.wibisono</groupId>
	    <artifactId>clj-socketio-client</artifactId>
	    <version>0.1.1-SNAPSHOT</version>
	</dependency>


                            
    libraryDependencies += "com.github.wibisono" % "clj-socketio-client" % "0.1.1-SNAPSHOT"


                            
    :dependencies [[com.github.wibisono/clj-socketio-client "0.1.1-SNAPSHOT"]]

Readme

clj-socketio-client

A Clojure library that wraps https://github.com/socketio/socket.io-client-java

Installation

Leiningen

[clj-socketio-client "0.1.0-SNAPSHOT"]

Usage

The Clojure wrapper provides a thin convenience layer atop the Java client.

(:require [clj-socketio-client.core :as sio])

(def s (sio/make-socket "http://host:port" event-map))
(sio/emit! s "message" args optional-unique-id)

The event map provided to make-socket maps standard or custom socket.io event names to variadic [& args] functions, which will be called asynchronously when messages are received.

The args argument to emit! may be a map, a sequential object (list, vector, ...) or a primitive (string, number, true false). The arguments are JSON-encoded into an array for transmission.

For convenience, the following are also available:

(sio/make-pass-take-socket url) constructs a socket with a predefined event map. When the socket is opened, it sends a "join" message, with a unique identifier.

(sio/pass-take msg) emits a "pass" message with the given msg arguments, and (synchronously) returns a Clojure promise to the value of a corresponding received "take" message from the remote service. The promise times out if not delivered within 60 seconds.

License

Distributed under the MIT License.