goczmq is a golang wrapper for CZMQ.
Switch branches/tags
Clone or download
taotetek Merge pull request #249 from arodland/channeler-options
Allow passing SockOptions to Channeler constructors
Latest commit ac82ea8 Aug 30, 2018
Permalink
Failed to load latest commit information.
cmd Problem: examples needed updating Nov 16, 2016
.gitignore Initial commit Sep 5, 2014
.travis.yml Problem: Travis CI slowed down by build-dependencies Mar 14, 2017
AUTHORS Problem: we have contributors who should be added to AUTHORS May 2, 2016
CONTRIBUTING.md Problem: I forgot an "a" in CONTRIBUTION.md Oct 2, 2015
LICENSE Initial commit Sep 5, 2014
Makefile golint and govet clean up Dec 7, 2014
README.md Problem: CZMQ 4.2 is required, not just 4.0+ Dec 17, 2017
auth.go Problem: we were leaking some c strings Oct 24, 2015
auth_test.go Problem: have places we do not check error returns Nov 11, 2017
beacon.go allow publishing beacon of byte slice, also allow receiving of byte s… Feb 19, 2016
beacon_test.go Problem: have places we do not check error returns Nov 11, 2017
cert.go Problem: new czmq release Nov 16, 2016
cert_test.go Problem: have places we do not check error returns Nov 11, 2017
certstore.go Problem: we were leaking some c strings Oct 24, 2015
certstore_test.go Problem: have places we do not check error returns Nov 11, 2017
channeler.go Handle SockOption args to NewSubChanneler as well Aug 8, 2018
channeler_test.go Problem: cannot make unsubscribed SubChanneler Jan 20, 2017
goczmq.go Problem: ubuntu has zmq packages without draft enabled Mar 14, 2017
license.xml can now create, bind, and destroy a zgossip actor Sep 20, 2014
poller.go clean up error messages Sep 13, 2015
poller_test.go Problem: test code was still inconsistent Oct 9, 2015
proxy.go Problem: we were leaking some c strings Oct 24, 2015
proxy_test.go Problem: have places we do not check error returns Nov 11, 2017
readwriter.go Problem: io.EOF on timeout was confusing Oct 8, 2015
readwriter_test.go Problem: found some minor code quality issues Nov 10, 2017
sock.go Problem: smart constructors do not accept options Oct 28, 2017
sock_draft.go Problem: ubuntu has zmq packages without draft enabled Mar 14, 2017
sock_draft_test.go Problem: ubuntu has zmq packages without draft enabled Mar 14, 2017
sock_option.go Problem: removing backwards compat on master is mean without more war… Oct 26, 2017
sock_option.gsl Problem: removing backwards compat on master is mean without more war… Oct 26, 2017
sock_option_test.go Problem: removing backwards compat on master is mean without more war… Oct 26, 2017
sock_option_test.gsl Problem: removing backwards compat on master is mean without more war… Oct 26, 2017
sock_test.go Problem: have places we do not check error returns Nov 11, 2017
sockopts.gsl killing zees Oct 14, 2014
sockopts.xml Problem: sock API surface area too large due to option setters Oct 26, 2017

README.md

goczmq Build Status Doc Status

Introduction

A golang interface to the CZMQ v4.2 API.

Install

Dependencies

For CZMQ master

go get github.com/zeromq/goczmq

A Note on Build Tags

The CZMQ library includes experimental classes that are not built by default, but can be built by passing --enable-drafts to configure. Support for these draft classes are being added to goczmq. To build these features against a CZMQ that has been compiled with --enable-drafts, use go build -tags draft.

For CMZQ = 4.2

go get gopkg.in/zeromq/goczmq.v4

Note: CZMQ 4.2 is has not been released yet.

For CZMQ Before 4.0

go get gopkg.in/zeromq/goczmq.v1

Usage

Direct CZMQ Sock API

Example

package main

import (
	"log"

	"github.com/zeromq/goczmq"
)

func main() {
	// Create a router socket and bind it to port 5555.
	router, err := goczmq.NewRouter("tcp://*:5555")
	if err != nil {
		log.Fatal(err)
	}
	defer router.Destroy()

	log.Println("router created and bound")

	// Create a dealer socket and connect it to the router.
	dealer, err := goczmq.NewDealer("tcp://127.0.0.1:5555")
	if err != nil {
		log.Fatal(err)
	}
	defer dealer.Destroy()

	log.Println("dealer created and connected")

	// Send a 'Hello' message from the dealer to the router.
	// Here we send it as a frame ([]byte), with a FlagNone
	// flag to indicate there are no more frames following.
	err = dealer.SendFrame([]byte("Hello"), goczmq.FlagNone)
	if err != nil {
		log.Fatal(err)
	}

	log.Println("dealer sent 'Hello'")

	// Receve the message. Here we call RecvMessage, which
	// will return the message as a slice of frames ([][]byte).
	// Since this is a router socket that support async
	// request / reply, the first frame of the message will
	// be the routing frame.
	request, err := router.RecvMessage()
	if err != nil {
		log.Fatal(err)
	}

	log.Printf("router received '%s' from '%v'", request[1], request[0])

	// Send a reply. First we send the routing frame, which
	// lets the dealer know which client to send the message.
	// The FlagMore flag tells the router there will be more
	// frames in this message.
	err = router.SendFrame(request[0], goczmq.FlagMore)
	if err != nil {
		log.Fatal(err)
	}

	log.Printf("router sent 'World'")

	// Next send the reply. The FlagNone flag tells the router
	// that this is the last frame of the message.
	err = router.SendFrame([]byte("World"), goczmq.FlagNone)
	if err != nil {
		log.Fatal(err)
	}

	// Receive the reply.
	reply, err := dealer.RecvMessage()
	if err != nil {
		log.Fatal(err)
	}

	log.Printf("dealer received '%s'", string(reply[0]))
}

Output

2015/05/26 21:52:52 router created and bound
2015/05/26 21:52:52 dealer created and connected
2015/05/26 21:52:52 dealer sent 'Hello'
2015/05/26 21:52:52 router received 'Hello' from '[0 103 84 189 175]'
2015/05/26 21:52:52 router sent 'World'
2015/05/26 21:52:52 dealer received 'World'

io.ReadWriter support

Example

package main

import (
	"log"

	"github.com/zeromq/goczmq"
)

func main() {
	// Create a router socket and bind it to port 5555.
	router, err := goczmq.NewRouter("tcp://*:5555")
	if err != nil {
		log.Fatal(err)
	}
	defer router.Destroy()

	log.Println("router created and bound")

	// Create a dealer socket and connect it to the router.
	dealer, err := goczmq.NewDealer("tcp://127.0.0.1:5555")
	if err != nil {
		log.Fatal(err)
	}
	defer dealer.Destroy()

	log.Println("dealer created and connected")

	// Send a 'Hello' message from the dealer to the router,
	// using the io.Write interface
	n, err := dealer.Write([]byte("Hello"))
	if err != nil {
		log.Fatal(err)
	}

	log.Printf("dealer sent %d byte message 'Hello'\n", n)

	// Make a byte slice and pass it to the router
	// Read interface. When using the ReadWriter
	// interface with a router socket, the router
	// caches the routing frames internally in a
	// FIFO and uses them transparently when
	// sending replies.
	buf := make([]byte, 16386)

	n, err = router.Read(buf)
	if err != nil {
		log.Fatal(err)
	}

	log.Printf("router received '%s'\n", buf[:n])

	// Send a reply.
	n, err = router.Write([]byte("World"))
	if err != nil {
		log.Fatal(err)
	}

	log.Printf("router sent %d byte message 'World'\n", n)

	// Receive the reply, reusing the previous buffer.
	n, err = dealer.Read(buf)
	if err != nil {
		log.Fatal(err)
	}

	log.Printf("dealer received '%s'", string(buf[:n]))
}

Output

2015/05/26 21:54:10 router created and bound
2015/05/26 21:54:10 dealer created and connected
2015/05/26 21:54:10 dealer sent 5 byte message 'Hello'
2015/05/26 21:54:10 router received 'Hello'
2015/05/26 21:54:10 router sent 5 byte message 'World'
2015/05/26 21:54:10 dealer received 'World'

Thread safe channel interface

Example

package main

import (
	"log"

	"github.com/zeromq/goczmq"
)

func main() {
	// Create a router channeler and bind it to port 5555.
	// A channeler provides a thread safe channel interface
	// to a *Sock
	router := goczmq.NewRouterChanneler("tcp://*:5555")
	defer router.Destroy()

	log.Println("router created and bound")

	// Create a dealer channeler and connect it to the router.
	dealer := goczmq.NewDealerChanneler("tcp://127.0.0.1:5555")
	defer dealer.Destroy()

	log.Println("dealer created and connected")

	// Send a 'Hello' message from the dealer to the router.
	dealer.SendChan <- [][]byte{[]byte("Hello")}
	log.Println("dealer sent 'Hello'")

	// Receve the message as a [][]byte. Since this is
	// a router, the first frame of the message wil
	// be the routing frame.
	request := <-router.RecvChan
	log.Printf("router received '%s' from '%v'", request[1], request[0])

	// Send a reply. First we send the routing frame, which
	// lets the dealer know which client to send the message.
	router.SendChan <- [][]byte{request[0], []byte("World")}
	log.Printf("router sent 'World'")

	// Receive the reply.
	reply := <-dealer.RecvChan
	log.Printf("dealer received '%s'", string(reply[0]))
}

Output

2015/05/26 21:56:43 router created and bound
2015/05/26 21:56:43 dealer created and connected
2015/05/26 21:56:43 dealer sent 'Hello'
2015/05/26 21:56:43 received 'Hello' from '[0 12 109 153 35]'
2015/05/26 21:56:43 router sent 'World'
2015/05/26 21:56:43 dealer received 'World'

GoDoc

godoc

See Also

License

This project uses the MPL v2 license, see LICENSE