protocol

package

v2.0.0+incompatible Latest Latest Go to latest Published: Nov 2, 2018 License: Apache-2.0 Imports: 3 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.1git.de/nanomsg/mangos

Documentation ¶

Overview ¶

Package protocol implements some common things protocol implementors need. Only protocol implementations should import this package.

Constants ¶

View Source

const (
	ProtoPair       = mangos.ProtoPair
	ProtoPub        = mangos.ProtoPub
	ProtoSub        = mangos.ProtoSub
	ProtoReq        = mangos.ProtoReq
	ProtoRep        = mangos.ProtoRep
	ProtoPush       = mangos.ProtoPush
	ProtoPull       = mangos.ProtoPull
	ProtoSurveyor   = mangos.ProtoSurveyor
	ProtoRespondent = mangos.ProtoRespondent
	ProtoBus        = mangos.ProtoBus
	ProtoStar       = mangos.ProtoStar // Experimental
)

Protocol numbers

View Source

const (
	ErrClosed      = errors.ErrClosed
	ErrSendTimeout = errors.ErrSendTimeout
	ErrRecvTimeout = errors.ErrRecvTimeout
	ErrBadValue    = errors.ErrBadValue
	ErrBadOption   = errors.ErrBadOption
	ErrProtoOp     = errors.ErrProtoOp
	ErrProtoState  = errors.ErrProtoState
	ErrCanceled    = errors.ErrCanceled
)

Borrow common error codes for convenience.

View Source

const (
	OptionRaw          = mangos.OptionRaw
	OptionRecvDeadline = mangos.OptionRecvDeadline
	OptionSendDeadline = mangos.OptionSendDeadline
	OptionRetryTime    = mangos.OptionRetryTime
	OptionSubscribe    = mangos.OptionSubscribe
	OptionUnsubscribe  = mangos.OptionUnsubscribe
	OptionSurveyTime   = mangos.OptionSurveyTime
	OptionWriteQLen    = mangos.OptionWriteQLen
	OptionReadQLen     = mangos.OptionReadQLen
	OptionLinger       = mangos.OptionLinger // Remove?
	OptionTTL          = mangos.OptionTTL
	OptionBestEffort   = mangos.OptionBestEffort
)

Common option definitions We have elided transport-specific options here.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Context ¶

type Context = mangos.ProtocolContext

Context describes a protocol context.

type Info ¶

type Info = mangos.ProtocolInfo

Info describes a protocol and it's peer.

type Message ¶

type Message = mangos.Message

Message is an alias for the common mangos.Message.

type Pipe ¶

type Pipe = mangos.ProtocolPipe

Pipe is a single connection -- provided by the transport layer.

type Protocol ¶

type Protocol = mangos.ProtocolBase

Protocol is the main ops vector for a protocol.

type Socket ¶

type Socket = mangos.Socket

Socket is the interface definition of a mangos.Socket. We need this for creating new ones.

func MakeSocket ¶

func MakeSocket(proto Protocol) Socket

MakeSocket creates a Socket on top of a Protocol.

Source Files ¶

View all Source files

protocol.go

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
bus Package bus implements the BUS protocol.	Package bus implements the BUS protocol.
pair Package pair implements the PAIR protocol.	Package pair implements the PAIR protocol.
pub Package pub implements the PUB protocol.	Package pub implements the PUB protocol.
pull Package pull implements the PULL protocol, which is the read side of the pipeline pattern.	Package pull implements the PULL protocol, which is the read side of the pipeline pattern.
push Package push implements the PUSH protocol, which is the write side of the pipeline pattern.	Package push implements the PUSH protocol, which is the write side of the pipeline pattern.
rep Package rep implements the REP protocol, which is the response side of the request/response pattern.	Package rep implements the REP protocol, which is the response side of the request/response pattern.
req Package req implements the REQ protocol, which is the request side of the request/response pattern.	Package req implements the REQ protocol, which is the request side of the request/response pattern.
respondent Package respondent implements the RESPONDENT protocol, which is the response side of the survey pattern.	Package respondent implements the RESPONDENT protocol, which is the response side of the survey pattern.
star Package star implements a new, experimental protocol called "STAR".	Package star implements a new, experimental protocol called "STAR".
sub Package sub implements the SUB protocol.	Package sub implements the SUB protocol.
surveyor Package surveyor implements the SURVEYOR protocol.	Package surveyor implements the SURVEYOR protocol.
xbus Package xbus implements the BUS protocol.	Package xbus implements the BUS protocol.
xpair Package xpair implements the PAIR protocol.	Package xpair implements the PAIR protocol.
xpub Package xpub implements the PUB protocol.	Package xpub implements the PUB protocol.
xpull Package xpull implements the PULL protocol.	Package xpull implements the PULL protocol.
xpush Package xpush implements the raw PUSH protocol.	Package xpush implements the raw PUSH protocol.
xrep Package xrep implements the raw REP protocol, which is the response side of the request/response pattern.	Package xrep implements the raw REP protocol, which is the response side of the request/response pattern.
xreq Package xreq implements the raw REQ protocol, which is the request side of the request/response pattern.	Package xreq implements the raw REQ protocol, which is the request side of the request/response pattern.
xrespondent Package xrespondent implements the raw RESPONDENT protocol, which is the response side of survey pattern.	Package xrespondent implements the raw RESPONDENT protocol, which is the response side of survey pattern.
xstar Package xstar implements the experimental star protocol.	Package xstar implements the experimental star protocol.
xsub Package xsub implements the raw SUB protocol.	Package xsub implements the raw SUB protocol.
xsurveyor Package xsurveyor implements the SURVEYOR protocol.	Package xsurveyor implements the SURVEYOR protocol.