package plainsession

import "github.com/hlandau/parazmq/plainsession"

Index ¶

• func New(fc abstract.FrameConn, cfg PlainConfig) (ps abstract.FrameConn, err error)
• type PlainConfig
• type PlainSession
• func (s *PlainSession) Close() error
• func (s *PlainSession) ReceiveFrame() ([]byte, abstract.ZMTPFlags, error)
• func (s *PlainSession) RemoteMetadata() map[string]string
• func (s *PlainSession) SendFrame(data []byte, flags abstract.ZMTPFlags) error

Functions ¶

func New ¶

func New(fc abstract.FrameConn, cfg PlainConfig) (ps abstract.FrameConn, err error)

Creates a PlainSession over the FrameConn as specified by the PlainConfig.

Types ¶

type PlainConfig ¶

type PlainConfig struct {
	IsServer bool
	Metadata map[string]string

	Username string
	Password string

	ServerValidateFunc func(username, password string) bool
}

type PlainSession ¶

type PlainSession struct {
	abstract.FrameConn
	// contains filtered or unexported fields
}

A PlainSession performs the PLAIN authentication mode handshake and exchanges frames in the process so described by the specification. The ZMTP/3.x greeting must already be complete.

func (*PlainSession) Close ¶

func (s *PlainSession) Close() error

func (*PlainSession) ReceiveFrame ¶

func (s *PlainSession) ReceiveFrame() ([]byte, abstract.ZMTPFlags, error)

func (*PlainSession) RemoteMetadata ¶

func (s *PlainSession) RemoteMetadata() map[string]string

Returns the remote metadata received during the handshake process.

func (*PlainSession) SendFrame ¶

func (s *PlainSession) SendFrame(data []byte, flags abstract.ZMTPFlags) error

Source Files ¶

plainsession.go