sub

Documentation

Overview

Package sub implements the SUB protocol. This protocol receives messages from publishers (PUB peers). The messages are filtered based on subscription, such that only subscribed messages (see OptionSubscribe) are received.

Note that in order to receive any messages, at least one subscription must be present. If no subscription is present (the default state), receive operations will block forever.

Index

• Constants
• func NewProtocol() protocol.Protocol
• func NewSocket() (protocol.Socket, error)

Constants

const (
	Self     = protocol.ProtoSub
	Peer     = protocol.ProtoPub
	SelfName = "sub"
	PeerName = "pub"
)

Protocol identity information.

Functions

func NewProtocol

func NewProtocol() protocol.Protocol

NewProtocol returns a new protocol implementation.

func NewSocket

func NewSocket() (protocol.Socket, error)

NewSocket allocates a new Socket using the SUB protocol.