README.md

Introduction

A golang interface to the Zyre v2.0 API. Wraps most of the API methods to idiomatic Go.

About Zyre

Zyre is a frameworkd for peer to peer networks written in ZeroMQ

Typical use cases for Zyre are:

• Local service discovery.
• Clustering of a set of services on the same Ethernet network.
• Controlling a network of smart devices (Internet of Things).
• Multi-user mobile applications (like smart classrooms).

Check Zyre Github page

Install

Dependencies

• libsodium
• libzmq
• czmq
• zyre

For GoZyre master

import "github.com/zeromq/gozyre"

Example

package main

import (
	"flag"
	"time"

	zyre "github.com/zeromq/gozyre"
)

const (
	Group = "THEROOM"
)

func main() {
	var name string
	flag.StringVar(&name, "name", "", "node name")
	flag.Parse()

	node := zyre.New(
        name,
        zyre.SetHeader("foo", "bar"),
        )
	defer node.Destroy()
	err := node.Start()
	if err != nil {
		panic(err)
	}
	err = node.Join(Group)
	if err != nil {
		panic(err)
	}
	for i := 0; i != 10; i++ {
		node.Shouts(Group, "Hello from %s", name)
		time.Sleep(250 * time.Millisecond)

		m, err := node.Recv()
		if err != nil {
			fmt.Printf("err=%s\n", err.Error())
		} else {
			switch m.(type) {
			case Shout:
				m := m.(Shout)
				fmt.Printf("%T{Peer:\"%s\", Name:\"%s\", Group:\"%s\", Message: []byte{\"%s\"}}\n", m, m.Peer, m.Name, m.Group, string(m.Message[0]))
			case Whisper:
				m := m.(Whisper)
				fmt.Printf("%T{Peer:\"%s\", Name:\"%s\", Message: []byte{\"%s\"}}\n", m, m.Peer, m.Name, string(m.Message[0]))
			default:
				fmt.Printf("%#+v\n", m)
			}
		}
	}

	node.Stop()
}

Note on panic

gozyre panics only when user try to operate on destroyed node

node := zyre.New()
...
node.Destroy()
node.Shout(...) <- panic

This is violation of API contract and SHALL not be done.

License

This project uses the MPL v2 license, see LICENSE.

It uses Collective Code Construction Contract for contributing, see CONTRIBUTING.md.