zmqutil

Documentation

Overview

various comm ZMq routines shared be all commands

Index

• func CloseClients(clients []*Client)
• func MakeKeyPair(publicKeyFileName string, privateKeyFileName string) error
• func NewBind(log *logger.L, socketType zmq.Type, zapDomain string, privateKey []byte, ...) (*zmq.Socket, *zmq.Socket, error)
• func NewMonitor(socket *zmq.Socket, connection string, event zmq.Event) (*zmq.Socket, error)
• func NewServerSocket(socketType zmq.Type, zapDomain string, privateKey []byte, publicKey []byte, ...) (*zmq.Socket, error)
• func NewSignalPair(signal string) (*zmq.Socket, *zmq.Socket, error)
• func ReadKeyFile(keyFileName string) ([]byte, bool, error)
• func ReadPrivateKeyFile(keyFileName string) ([]byte, error)
• func ReadPublicKeyFile(keyFileName string) ([]byte, error)
• func StartAuthentication() error
• type Client
  • func ClientFromSocket(socket *zmq.Socket) *Client
  • func NewClient(socketType zmq.Type, privateKey []byte, publicKey []byte, ...) (*Client, error)
  • func (client *Client) BeginPolling(poller *Poller, events zmq.State) *zmq.Socket
  • func (client *Client) Close() error
  • func (client *Client) Connect(conn *util.Connection, serverPublicKey []byte, prefix string) error
  • func (client *Client) ConnectedTo() *Connected
  • func (client *Client) IsConnected() bool
  • func (client *Client) IsConnectedTo(serverPublicKey []byte) bool
  • func (client *Client) Receive(flags zmq.Flag) ([][]byte, error)
  • func (client *Client) Reconnect() error
  • func (client *Client) ReconnectReturningSocket() (*zmq.Socket, error)
  • func (client *Client) Send(items ...interface{}) error
  • func (client *Client) String() string
• type Connected
• type Poller
  • func NewPoller() *Poller
  • func (poller *Poller) Add(socket *zmq.Socket, events zmq.State)
  • func (poller *Poller) Poll(timeout time.Duration) ([]zmq.Polled, error)
  • func (poller *Poller) Remove(socket *zmq.Socket)

Functions

func CloseClients

func CloseClients(clients []*Client)

disconnect old addresses and close all

func MakeKeyPair

func MakeKeyPair(publicKeyFileName string, privateKeyFileName string) error

create a new public/private keypair and write them to separate files

func NewBind

func NewBind(log *logger.L, socketType zmq.Type, zapDomain string, privateKey []byte, publicKey []byte, listen []*util.Connection) (*zmq.Socket, *zmq.Socket, error)

bind a list of addresses creates up to 2 sockets for separate IPv4 and IPv6 traffic

func NewMonitor

func NewMonitor(socket *zmq.Socket, connection string, event zmq.Event) (*zmq.Socket, error)

return a socket connection to the monitoring channel of another socket for connection state signalling a unique inproc://name must be provided for each use

func NewServerSocket

func NewServerSocket(socketType zmq.Type, zapDomain string, privateKey []byte, publicKey []byte, v6 bool) (*zmq.Socket, error)

create a socket suitable for a server side connection

func NewSignalPair

func NewSignalPair(signal string) (*zmq.Socket, *zmq.Socket, error)

return a pair of connected push/pull sockets for shutdown signalling

func ReadKeyFile

func ReadKeyFile(keyFileName string) ([]byte, bool, error)

read a public key from a file returning it as a 32 byte string

func ReadPrivateKeyFile

func ReadPrivateKeyFile(keyFileName string) ([]byte, error)

read a private key from a file returning it as a 32 byte string

func ReadPublicKeyFile

func ReadPublicKeyFile(keyFileName string) ([]byte, error)

read a public key from a file returning it as a 32 byte string

func StartAuthentication

func StartAuthentication() error

initilaise the ZMQ security subsystem

Types

type Client

type Client struct {
	sync.Mutex
	// contains filtered or unexported fields
}

structure to hold a client connection

prefix:

REQ socket this adds an item before send
SUB socket this adds/changes subscription

func ClientFromSocket

func ClientFromSocket(socket *zmq.Socket) *Client

find the client corresponding to a socket

func NewClient

func NewClient(socketType zmq.Type, privateKey []byte, publicKey []byte, timeout time.Duration) (*Client, error)

create a client socket ususlly of type zmq.REQ or zmq.SUB

func (*Client) BeginPolling

func (client *Client) BeginPolling(poller *Poller, events zmq.State) *zmq.Socket

add poller to client

func (*Client) Close

func (client *Client) Close() error

disconnect old address and close

func (*Client) Connect

func (client *Client) Connect(conn *util.Connection, serverPublicKey []byte, prefix string) error

disconnect old address and connect to new

func (*Client) ConnectedTo

func (client *Client) ConnectedTo() *Connected

to string

func (*Client) IsConnected

func (client *Client) IsConnected() bool

check if connected to a node

func (*Client) IsConnectedTo

func (client *Client) IsConnectedTo(serverPublicKey []byte) bool

check if connected to a specific node

func (*Client) Receive

func (client *Client) Receive(flags zmq.Flag) ([][]byte, error)

receive a reply

func (*Client) Reconnect

func (client *Client) Reconnect() error

close and reopen the connection

func (*Client) ReconnectReturningSocket

func (client *Client) ReconnectReturningSocket() (*zmq.Socket, error)

close and reopen the connection

func (*Client) Send

func (client *Client) Send(items ...interface{}) error

send a message

func (*Client) String

func (client *Client) String() string

to string

type Connected

type Connected struct {
	Address string `json:"address"`
	Server  string `json:"server"`
}

type Poller

type Poller struct {
	sync.Mutex
	// contains filtered or unexported fields
}

structure to hold a poller

func NewPoller

func NewPoller() *Poller

create a poller this is just to encapsulate the zmq poller to allow removal of a socket from a socket

func (*Poller) Add

func (poller *Poller) Add(socket *zmq.Socket, events zmq.State)

add a socket to a poller

func (*Poller) Poll

func (poller *Poller) Poll(timeout time.Duration) ([]zmq.Polled, error)

perform a poll

func (*Poller) Remove

func (poller *Poller) Remove(socket *zmq.Socket)

remove a socket from a poller