zeromq / zwssock

ZeroMQ WebSocket library for CZMQ

ZWSSock - ZeroMQ over WebSocket library

ZWSSock implements ZWS (ZeroMQ WebSocket) for use in ZeroMQ applications. Additionally it supports Compression Extensions for WebSocket for per message deflate.

ZWS and ZWSSock are both in early stage and the protocol is not yet finalized nor is this library. The API of ZWSSock is very similar to the API of zsock of CZMQ v3.0, so using it should be very simple. While ZWSSock implements the server side of ZWS JSMQ library implement ZWS on the browser side. JSMQ is javascript library which implements the ZWS protocol and exposes ZeroMQ like API. More information is available via the JSMQ repository.

With JSMQ and ZWSSock, javascript applications can talk directly to ZeroMQ applications without a webserver in the middle, however if you want to use SSL (e.g wss://someaddress) you will need a webserver or loadbalaner in the middle to terminate SSL because ZWSSock does not support SSL.

Please note that when using WebSocket it is recommended to do it over SSL because not all firewalls likes non-text protocols over port 80.

ZWSSock currently implements the router pattern. Publisher pattern is next to come (JSMQ implements subscriber and dealer).

To use the ZWSSock take a look at main.c file. The project also includes browser side example.

On Linux please review src/CZMQ-ZWSSock/Makefile - CFLAGS and LIBS assume an installation of pkg-config. The code is tested with ØMQ=4.0.4 czmq=2.2.0. To build:

cd src/CZMQ-ZWSSock
make

This creates the 'zwstest' program in the same directory. By default zwstest will listen on 127.0.0.1:8000. Pass a different listen socket as single argument:

 ./zwstest tcp://0.0.0.0:1234

zwssock's Issues

Call for maintainers

If you'd like to help click that lovely green "Merge Pull Request" button, and get eternal karma, add a comment confirming that you've read and understand the C4 process at http://rfc.zeromq.org/spec:16.

Assert (!more)

At this moment multipart messages containing more than one frame cause the library to assert, unless asserting is disabled of course. What was the reason for the assert?

https://github.com/zeromq/zwssock/blob/master/src/CZMQ-ZWSSock/zwssock.c#L185

Could not compile with msvc 2013

Error 13 error C2275: 'zmq_pollitem_t' : illegal use of this type as an expression R:\zwssock-master\src\CZMQ-ZWSSock\zwssock.c 435 1 CZMQ-ZWSSock

434: // We always poll all three sockets
435: zmq_pollitem_t pollitems[] = {
436: { self->control, 0, ZMQ_POLLIN, 0 },
437: { self->stream, 0, ZMQ_POLLIN, 0 },
438: { self->data, 0, ZMQ_POLLIN, 0 }
439: };

Building with make instructions

Short instruction on how to build the project on the readme.md file is needed.

@mhaberler can you help with that?

Possible memory leak?

I am reviewing the example. Shouldn't there be a zmsg_destroy(&msg); after line 55?

https://github.com/zeromq/zwssock/blob/master/src/CZMQ-ZWSSock/main.c#L55

QA tests voor zwssock

For the ease of development and make the product more durable we would like to have a QA suite.

Suggestions in this issue would be:

1. Which language should it be written in?
2. What client implementation for websockets can be used to do some quality testing. For example an implementation that implements extensions, but is also able to disable it.
3. Do we want to describe explicit code and formatting guidelines?

News?

I try to use zwssock with JSMQ to use ZeroMQ over WebSocket to link JavaScript browser-side app to a c++ backend.

I would like to implement a REQ-REP and a SUB-PUB patterns the first use for client ask some think to backend and get a result just after.
The second SUB-PUB is use to send recurrent update from server to subscribers (JavaScript browser-side app).

Currently I found no way to broadcast message with a topic to all client was connected.
So REQ-REP works (with JSMQ.Dealer) but SUB-PUB does not work...

Do you plan to fully implement ZeroMQ WebSocket RFC in order link any JavaScript browser-side app to any backend?

Could not compile VS2017/Win10

I get these errors trying to build ZWSSOCK in X64/Release config:

Severity Code Description Project File Line Suppression State
Error LNK1120 9 unresolved externals CZMQ-ZWSSock C:\Users\sam\RubymineProjects\untitled\ZWSSock\src\x64\Release\CZMQ-ZWSSock.exe 1
Error LNK2001 unresolved external symbol __imp_zmq_poll CZMQ-ZWSSock C:\Users\sam\RubymineProjects\untitled\ZWSSock\src\CZMQ-ZWSSock\zwssock.obj 1
Error LNK2001 unresolved external symbol __imp_zmq_send CZMQ-ZWSSock C:\Users\sam\RubymineProjects\untitled\ZWSSock\src\CZMQ-ZWSSock\zwssock.obj 1
Error LNK2001 unresolved external symbol __imp_zmq_version CZMQ-ZWSSock C:\Users\sam\RubymineProjects\untitled\ZWSSock\src\CZMQ-ZWSSock\main.obj 1
Error LNK2001 unresolved external symbol __imp_zsocket_bind CZMQ-ZWSSock C:\Users\sam\RubymineProjects\untitled\ZWSSock\src\CZMQ-ZWSSock\zwssock.obj 1
Error LNK2001 unresolved external symbol __imp_zsocket_connect CZMQ-ZWSSock C:\Users\sam\RubymineProjects\untitled\ZWSSock\src\CZMQ-ZWSSock\zwssock.obj 1
Error LNK2001 unresolved external symbol __imp_zsocket_new CZMQ-ZWSSock C:\Users\sam\RubymineProjects\untitled\ZWSSock\src\CZMQ-ZWSSock\zwssock.obj 1
Error LNK2001 unresolved external symbol __imp_zsocket_sendmem CZMQ-ZWSSock C:\Users\sam\RubymineProjects\untitled\ZWSSock\src\CZMQ-ZWSSock\zwssock.obj 1
Error LNK2001 unresolved external symbol __imp_zsocket_unbind CZMQ-ZWSSock C:\Users\sam\RubymineProjects\untitled\ZWSSock\src\CZMQ-ZWSSock\zwssock.obj 1
Error LNK2001 unresolved external symbol __imp_zthread_fork CZMQ-ZWSSock C:\Users\sam\RubymineProjects\untitled\ZWSSock\src\CZMQ-ZWSSock\zwssock.obj 1

My linker configuration:
C:\czmq\libzmq\bin\x64\Release\v141\static\libzmq.lib
C:\czmq\czmq\bin\x64\Release\v141\dynamic\libczmq.lib
C:\czmq\zlib-1.2.11\contrib\vstudio\vc14\x64\ZlibStatRelease\zlibstat.lib
%(AdditionalDependencies)