Categorygithub.com/go-zeromq/zmq4
modulepackage
0.17.0
Repository: https://github.com/go-zeromq/zmq4.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
22
Dependents
47
Files
3.2k SLOC

# README

zmq4

GitHub release go.dev reference CI codecov GoDoc License DOI

zmq4 is a pure-Go implementation of ØMQ (ZeroMQ), version 4.

See zeromq.org for more informations.

Development

zmq4 needs a caring maintainer. I (sbinet) have not much time to dedicate anymore to this project (as $WORK doesn't need it anymore).

License

zmq4 is released under the BSD-3 license.

Documentation

Documentation for zmq4 is served by GoDoc.

# Packages

No description provided by the author
No description provided by the author
Package transport defines the Transport interface and provides a net-based implementation that can be used by zmq4 sockets to exchange messages.

# Functions

NewDealer returns a new DEALER ZeroMQ socket.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewPair returns a new PAIR ZeroMQ socket.
NewProxy creates a new Proxy value.
NewPub returns a new PUB ZeroMQ socket.
NewPull returns a new PULL ZeroMQ socket.
NewPush returns a new PUSH ZeroMQ socket.
No description provided by the author
NewRep returns a new REP ZeroMQ socket.
NewReq returns a new REQ ZeroMQ socket.
NewRouter returns a new ROUTER ZeroMQ socket.
NewSub returns a new SUB ZeroMQ socket.
NewXPub returns a new XPUB ZeroMQ socket.
NewXSub returns a new XSUB ZeroMQ socket.
Open opens a ZMTP connection over rw with the given security, socket type and identity.
RegisterTransport registers a new transport with the zmq4 package.
Transports returns the sorted list of currently registered transports.
WithAutomaticReconnect allows to configure a socket to automatically reconnect on connection loss.
WithDialerMaxRetries configures the maximum number of retries when dialing an endpoint (-1 means infinite retries).
WithDialerRetry configures the time to wait before two failed attempts at dialing an endpoint.
WithDialerTimeout sets the maximum amount of time a dial will wait for a connect to complete.
WithID configures a ZeroMQ socket identity.
WithLogger sets a dedicated log.Logger for the socket.
WithSecurity configures a ZeroMQ socket to use the given security mechanism.
WithTimeout sets the timeout value for socket operations.

# Constants

ZMTP commands as per: https://rfc.zeromq.org/spec:23/ZMTP/#commands.
ZMTP commands as per: https://rfc.zeromq.org/spec:23/ZMTP/#commands.
ZMTP commands as per: https://rfc.zeromq.org/spec:23/ZMTP/#commands.
ZMTP commands as per: https://rfc.zeromq.org/spec:23/ZMTP/#commands.
No description provided by the author
ZMTP commands as per: https://rfc.zeromq.org/spec:23/ZMTP/#commands.
ZMTP commands as per: https://rfc.zeromq.org/spec:23/ZMTP/#commands.
ZMTP commands as per: https://rfc.zeromq.org/spec:23/ZMTP/#commands.
ZMTP commands as per: https://rfc.zeromq.org/spec:23/ZMTP/#commands.
ZMTP commands as per: https://rfc.zeromq.org/spec:23/ZMTP/#commands.
ZMTP commands as per: https://rfc.zeromq.org/spec:23/ZMTP/#commands.
CurveSecurity uses ZMQ_CURVE for authentication and encryption.
a ZMQ_DEALER socket.
NullSecurityType is an empty security mechanism that does no authentication nor encryption.
No description provided by the author
No description provided by the author
No description provided by the author
a ZMQ_PAIR socket.
PlainSecurity is a security mechanism that uses plaintext passwords.
a ZMQ_PUB socket.
a ZMQ_PULL socket.
a ZMQ_PUSH socket.
a ZMQ_REP socket.
a ZMQ_REQ socket.
a ZMQ_ROUTER socket.
a ZMQ_SUB socket.
No description provided by the author
a ZMQ_XPUB socket.
a ZMQ_XSUB socket.

# Variables

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

Cmd is a ZMTP Cmd as per: https://rfc.zeromq.org/spec:23/ZMTP/#formal-grammar.
Conn implements the ZeroMQ Message Transport Protocol as defined in https://rfc.zeromq.org/spec:23/ZMTP/.
Msg is a ZMTP message, possibly composed of multiple frames.
Property describes a Conn metadata's entry.
Proxy connects a frontend socket to a backend socket.
No description provided by the author
UnknownTransportError records an error when trying to use an unknown transport.

# Interfaces

Security is an interface for ZMTP security mechanisms.
Socket represents a ZeroMQ socket.
Topics is an interface that wraps the basic Topics method.

# Type aliases

Metadata is describing a Conn's metadata information.
No description provided by the author
Option configures some aspect of a ZeroMQ socket.
SecurityType denotes types of ZMTP security mechanisms.
SocketIdentity is the ZMTP metadata socket identity.
SocketType is a ZeroMQ socket type.