zmtp

Documentation

Index

• Constants
• Variables
• type ByteReader
  • func (b ByteReader) Read(p []byte) (n int, err error)
• type Command
  • func (c Command) BodyLen() int32
  • func (c *Command) ReadFrom(r io.Reader) (int64, error)
  • func (c Command) WriteTo(w io.Writer) (int64, error)
• type CommandOrMessage
  • func (dat *CommandOrMessage) ReadFrom(r io.Reader) (n int64, err error)
• type Greeting
  • func NewGreeting() Greeting
  • func (g *Greeting) Mechanism() string
  • func (g *Greeting) ReadFrom(r io.Reader) (int64, error)
  • func (g *Greeting) Server() bool
  • func (g *Greeting) SetMechanism(mech string)
  • func (g *Greeting) SetServer(server bool)
  • func (g *Greeting) SetVersionMajor(major uint8)
  • func (g *Greeting) SetVersionMinor(minor uint8)
  • func (g *Greeting) String() string
  • func (g *Greeting) VersionMajor() uint8
  • func (g *Greeting) VersionMinor() uint8
  • func (g *Greeting) WriteTo(w io.Writer) (int64, error)
• type Mechanism
• type Message
  • func (m *Message) ReadFrom(r io.Reader) (int64, error)
  • func (m Message) WriteTo(w io.Writer) (int64, error)
• type Metadata
  • func (m *Metadata) AddProperty(name string, value string) error
  • func (m Metadata) Properties(f func(name string, value string)) error
• type Socket

Constants

const (
	OptionServer = "server"
	OptionPubKey = "pubkey"
	OptionSecKey = "seckey"
	OptionSrvKey = "srvkey"
)

Variables

var ErrInvalidCommandSize invalidCommandSize

var ErrInvalidFrameHeader invalidFrameHeader

var ErrInvalidMetadata invalidMetadata

ErrInvalidMetadata is returned when the metadata cannot be parsed into its properties.

var ErrInvalidNameLength invalidNameLength

var ErrMechMismatch mechMismatch

var ErrNameTooLong nameTooLong

ErrNameTooLong is returns when the metadata contains a name specifier which is too long for the metadata length.

Types

type ByteReader

type ByteReader byte

func (ByteReader) Read

func (b ByteReader) Read(p []byte) (n int, err error)

type Command

type Command struct {
	Name string
	Body []byte
}

func (Command) BodyLen

func (c Command) BodyLen() int32

BodyLen returns the body length of the given message.

func (*Command) ReadFrom

func (c *Command) ReadFrom(r io.Reader) (int64, error)

ReadFrom reads a command from the given reader.

func (Command) WriteTo

func (c Command) WriteTo(w io.Writer) (int64, error)

WriteTo writes a command to the given writer.

type CommandOrMessage

type CommandOrMessage struct {
	// IsMessage is true iff this contains a message.
	IsMessage bool

	// Command is non nil iff message is nil.
	Command *Command

	// Message is non nil iff IsMessage is true.
	Message *Message
}

CommandOrMessage may either contain a command or a message.

func (*CommandOrMessage) ReadFrom

func (dat *CommandOrMessage) ReadFrom(r io.Reader) (n int64, err error)

type Greeting

type Greeting [64]byte

Greeting defines a zmtp greeting

func NewGreeting

func NewGreeting() Greeting

NewGreeting returns a new zmtp greeting.

func (*Greeting) Mechanism

func (g *Greeting) Mechanism() string

Mechanism returns the mechanism for this Greeting.

func (*Greeting) ReadFrom

func (g *Greeting) ReadFrom(r io.Reader) (int64, error)

ReadFrom reads the greeting from a reader.

func (*Greeting) Server

func (g *Greeting) Server() bool

Server returns whether the greeting specifies the sender as a server.

func (*Greeting) SetMechanism

func (g *Greeting) SetMechanism(mech string)

SetMechanism sets the mechanism for this greeting.

func (*Greeting) SetServer

func (g *Greeting) SetServer(server bool)

SetServer sets the server flag in the greeting.

func (*Greeting) SetVersionMajor

func (g *Greeting) SetVersionMajor(major uint8)

SetVersionMajor sets the major version of this zmtp greeting.

func (*Greeting) SetVersionMinor

func (g *Greeting) SetVersionMinor(minor uint8)

SetVersionMinor sets the minor version of this zmtp greeting.

func (*Greeting) String

func (g *Greeting) String() string

String implements Stringer for greeting.

func (*Greeting) VersionMajor

func (g *Greeting) VersionMajor() uint8

VersionMajor returns the major version of this zmtp greeting.

func (*Greeting) VersionMinor

func (g *Greeting) VersionMinor() uint8

VersionMinor returns the minor version of this zmtp greeting.

func (*Greeting) WriteTo

func (g *Greeting) WriteTo(w io.Writer) (int64, error)

WriteTo writes the greeting to a writer.

type Mechanism

type Mechanism interface {
	// Name of the mechanism.
	Name() string

	// ValidateGreeting returns an error if the greeting from another side is invalid for this mechanism.
	ValidateGreeting(*Greeting) (err error)

	// Handshake performs a handshake with the Connection.
	Handshake(net.Conn, Metadata) (s Socket, meta Metadata, err error)

	// Server field for the greeting for this handshake.
	Server() bool

	// SetOption sets an option in the mechanism.
	SetOption(option string, value any) error
}

Mechanism implements the setup of new Connections.

type Message

type Message struct {
	More bool
	Body []byte
}

Message is a zmtp message.

func (*Message) ReadFrom

func (m *Message) ReadFrom(r io.Reader) (int64, error)

ReadFrom reads a message from the given reader.

func (Message) WriteTo

func (m Message) WriteTo(w io.Writer) (int64, error)

WriteTo writes a message to the given writer.

type Metadata

type Metadata []byte

func (*Metadata) AddProperty

func (m *Metadata) AddProperty(name string, value string) error

AddProperty to the Metadata.

func (Metadata) Properties

func (m Metadata) Properties(f func(name string, value string)) error

Properties returns a slice of properties held in this metadata.

type Socket

type Socket interface {
	// Read the next part of traffic.
	Read() (CommandOrMessage, error)

	// Send a message on the socket.
	SendMessage(Message) error

	// SendCommand sends a command on the socket.
	SendCommand(Command) error

	// Access to the underlying conn.
	Net() net.Conn

	// Close the socket.
	Close() error
}

Socket.