Minor documentation improvements

CHANGELOG.md

@@ -1,3 +1,11 @@
+## 1.0.0-dev.7
+
+### Minor documentation improvements
+- Fix rename of `SocketMode` to `SocketType` in README
+- Add receiving messages (`ZMessage`, `ZFrame` and payloads) to README and example
+- Override `toString` function in `ZMessage` and `ZFrame` for better debugging experience
+
+
 ## 1.0.0-dev.6
 
 ### Free pointers before throwing a ZeroMQException

README.md

@@ -36,7 +36,7 @@ final ZContext context = ZContext();
 
 Create socket
 ```dart
-final ZSocket socket = context.createSocket(SocketMode.req);
+final ZSocket socket = context.createSocket(SocketType.req);
 ```
 
 Connect socket
@@ -49,6 +49,27 @@ Send message
 socket.send([1, 2, 3, 4, 5]);
 ```
 
+Receive `ZMessage`s
+```dart
+_socket.messages.listen((message) {
+    // Do something with message
+});
+```
+
+Receive `ZFrame`s
+```dart
+_socket.frames.listen((frame) {
+    // Do something with frame
+});
+```
+
+Receive payloads (`Uint8List`)
+```dart
+_socket.payloads.listen((payload) {
+    // Do something with payload
+});
+```
+
 Destroy socket
 ```dart
 socket.close();

example/lib/main.dart

@@ -1,3 +1,5 @@
+import 'dart:async';
+
 import 'package:dartzmq/dartzmq.dart';
 import 'package:flutter/material.dart';
 
@@ -31,19 +33,43 @@ class MyHomePage extends StatefulWidget {
 class _MyHomePageState extends State<MyHomePage> {
   final ZContext _context = ZContext();
   late final ZSocket _socket;
+  String _receivedData = '';
+  late StreamSubscription _subscription;
 
   @override
   void initState() {
     _socket = _context.createSocket(SocketType.req);
     _socket.connect("tcp://localhost:5566");
     // _socket.connect("tcp://192.168.2.18:5566");
+
+    // listen for messages
+    _subscription = _socket.messages.listen((message) {
+      setState(() {
+        _receivedData = message.toString();
+      });
+    });
+
+    // listen for frames
+    // _subscription = _socket.frames.listen((frame) {
+    //   setState(() {
+    //     _receivedData = frame.toString();
+    //   });
+    // });
+
+    // listen for payloads
+    // _subscription = _socket.payloads.listen((payload) {
+    //   setState(() {
+    //     _receivedData = payload.toString();
+    //   });
+    // });
     super.initState();
   }
 
   @override
   void dispose() {
     _socket.close();
     _context.stop();
+    _subscription.cancel();
     super.dispose();
   }
 
@@ -61,14 +87,14 @@ class _MyHomePageState extends State<MyHomePage> {
         child: Column(
           mainAxisAlignment: MainAxisAlignment.center,
           children: <Widget>[
-            const Text(
-              'Press to send a message',
-            ),
+            const Text('Press to send a message'),
             MaterialButton(
               onPressed: _sendMessage,
               color: Colors.blue,
               child: const Text('Send'),
-            )
+            ),
+            const Text('Received'),
+            Text(_receivedData),
           ],
         ),
       ),

example/pubspec.lock

@@ -56,7 +56,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "1.0.0-dev.4"
+    version: "1.0.0-dev.7"
   fake_async:
     dependency: transitive
     description:

lib/src/zeromq.dart

@@ -351,6 +351,9 @@ class ZFrame {
   final bool hasMore;
 
   ZFrame(this.payload, {this.hasMore = false});
+
+  @override
+  String toString() => 'ZFrame[$payload]';
 }
 
 /// ZMessage provides a list-like container interface,
@@ -496,6 +499,10 @@ class ZMessage implements Queue<ZFrame> {
 
   @override
   Iterable<T> whereType<T>() => _frames.whereType<T>();
+
+  @override
+  String toString() =>
+      IterableBase.iterableToFullString(this, 'ZMessage[', ']');
 }
 
 /// ZeroMQ sockets present an abstraction of an asynchronous message queue,

pubspec.yaml

@@ -1,6 +1,6 @@
 name: dartzmq
 description: A simple dart zeromq implementation/wrapper around the libzmq C++ library
-version: 1.0.0-dev.6
+version: 1.0.0-dev.7
 homepage: https://github.com/enwi/dartzmq
 
 environment: