From b0c712c146b208ac9dad5fd5829a2bc38773a4de Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?P=C5=99emysl=20Janouch?= Date: Sun, 29 Mar 2015 00:37:12 +0100 Subject: Stubplement WebSockets --- README | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) (limited to 'README') diff --git a/README b/README index df9b968..96e02b7 100644 --- a/README +++ b/README @@ -6,17 +6,29 @@ json-rpc-shell This software has been created as a replacement for the following shell, which is written in Java: http://software.dzhuvinov.com/json-rpc-2.0-shell.html -Fuck Java. With a sharp, pointy object. In the ass. Hard. json-c as well. - Supported transports -------------------- - HTTP - HTTPS + - WebSocket + - WebSocket over TLS + +WebSockets +---------- +The WebSocket transport is rather experimental. As the JSON-RPC 2.0 spec +doesn't say almost anything about the underlying transports, I'll shortly +describe the way it's implemented: every request is sent as a single text +message. If it has an "id" field, i.e. it's not just a notification, the +client waits for a message from the server in response. + +There's no support so far for any protocol extensions, nor for specifying +the higher-level protocol (the "Sec-Ws-Protocol" HTTP field). Building and Running -------------------- -Build dependencies: CMake, pkg-config, help2man, liberty (included) -Runtime dependencies: libev, Jansson, cURL, readline +Build dependencies: CMake, pkg-config, help2man, + liberty (included), http-parser (included) +Runtime dependencies: libev, Jansson, cURL, readline, openssl $ git clone https://github.com/pjanouch/json-rpc-shell.git $ git submodule init -- cgit v1.2.3