A simple dart zeromq implementation/wrapper around the libzmq C++ library
Currently supported:
pair
, pub
, sub
, req
, rep
, dealer
, router
, pull
, push
, xPub
, xSub
, stream
)
server
, client
, radio
, dish
, channel
, peer
, raw
, scatter
and gather
List<int>
, String
, ZFrame
or ZMessage
)bind(String address)
)connect(String address)
)setCurvePublicKey(String key)
, setCurveSecretKey(String key)
and setCurveServerKey(String key)
)setOption(int option, String value)
)ZMessage
)sub
sockets (subscribe(String topic)
and unsubscribe(String topic)
)ZMonitor
and MonitoredZSocket
)ZSocket
) and Synchronous (ZSyncSocket
) socketsCurrently Windows and Android are officially supported as platforms. Basically there a no extra setup steps unless the provided zeromq binary does not work for your platform. I have tested this on Windows and Android, which both work. Other platforms have not been tested, but should work. If you have tested this plugin on another platform and got it to work, please share your steps and create an issue so I can add it to the list below.
Create context
final ZContext context = ZContext();
Create asynchronous socket
final ZSocket socket = context.createSocket(SocketType.req);
Create synchronous socket
final ZSyncSocket socket = context.createSocket(SocketType.req);
Connect socket
socket.connect("tcp://localhost:5566");
Send message
socket.send([1, 2, 3, 4, 5]);
socket.sendString('My Message');
socket.sendFrame(ZFrame([1, 2, 3, 4, 5]));
var message = ZMessage();
message.add(ZFrame([1, 2, 3, 4, 5]));
message.add(ZFrame([6, 7, 8, 9, 10]));
socket.sendMessage(message, flags: ZMQ_DONTWAIT);
Receive ZMessage
s
socket.messages.listen((message) {
// Do something with message
});
Receive ZFrame
s
socket.frames.listen((frame) {
// Do something with frame
});
Receive payloads (Uint8List
)
socket.payloads.listen((payload) {
// Do something with payload
});
NOTE: If you're trying to use req/rep pattern, consider using either a
ZSyncSocket
and callsocket.recv()
or aZSocket
of typeSocketType.dealer
instead. For the latter you need to add an empty ZFrame at the beginning of your ZMessage as identification.
Receive socket events
final MonitoredZSocket socket = context.createMonitoredSocket(SocketType.req);
socket.events.listen((event) {
log('Received event ${event.event} with value ${event.value}');
});
final ZSocket socket = context.createSocket(SocketType.req);
final ZMonitor monitor = ZMonitor(
context: context,
socket: socket,
event: ZMQ_EVENT_CONNECTED | ZMQ_EVENT_CLOSED, // Only listen for connected and closed events
);
monitor.events.listen((event) {
log('Received event ${event.event} with value ${event.value}');
});
Destroy socket
socket.close();
Destroy monitor
monitor.close();
Destroy context
context.stop();
libzmq
binaryPlace a shared library of libzmq
next to your executable (for example place libzmq-v142-mt-4_3_5.dll
in the folder yourproject/build/windows/runner/Debug/
)
You can use a shared library of
libzmq
or compile it yourself. Especially when using this on windows you need to make sure thatlibzmq
is compiled usingMSVC-2019
if you are usingclang
it will not work (more info)
Note that you need to use Android NDK version r21d. Newer versions are currently not supported (see https://github.com/zeromq/libzmq/issues/4276)
libzmq.so
for different platforms
curve
support make sure to set the environment variable CURVE
either to export CURVE=libsodium
or export CURVE=tweetnacl
before running the build commandlibc++_shared.so
files located inside the Android NDK as in step 2 (reference)
ndk\21.4.7075529\toolchains\llvm\prebuilt\windows-x86_64\sysroot\usr\lib
Note IOS arm64 architecture supported so it will run from iPhone5s to the latest Iphone, Ipads devices
- To make it Run on simulator you have to modify the podspec file in the ios directory of plugin
- modify this - s.pod_target_xcconfig = { "OTHER_LDFLAGS" => "$(inherited) -force_load $(PODS_TARGET_SRCROOT)/Frameworks/libzmq.a -lstdc++" }
- From s.pod_target_xcconfig = { "OTHER_LDFLAGS" => "$(inherited) -force_load $(PODS_TARGET_SRCROOT)/Frameworks/libzmq.a -lstdc++" }
- To s.pod_target_xcconfig = { "OTHER_LDFLAGS" => "$(inherited) -force_load $(PODS_TARGET_SRCROOT)/Frameworks/libzmq_simulator.a -lstdc++" }