conn

Documentation

Index

• Variables
• func NetPipe() (net.Conn, net.Conn)
• type Channel
  • func (ch *Channel) SetLogger(l log.Logger)
• type ChannelDescriptor
  • func (chDesc ChannelDescriptor) FillDefaults() (filled ChannelDescriptor)
• type ChannelStatus
• type ConnectionStatus
• type MConnConfig
  • func DefaultMConnConfig() MConnConfig
• type Network
  • func NewNetwork(conn net.Conn, chDescs []*ChannelDescriptor, onReceive receiveCbFunc, ...) *Network
  • func NewNetworkWithConfig(conn net.Conn, chDescs []*ChannelDescriptor, onReceive receiveCbFunc, ...) *Network
  • func (c *Network) CanSend(chID byte) bool
  • func (c *Network) FlushStop()
  • func (c *Network) OnStart() error
  • func (c *Network) OnStop()
  • func (c *Network) Send(chID byte, msgBytes []byte) bool
  • func (c *Network) SetLogger(l log.Logger)
  • func (c *Network) Status() ConnectionStatus
  • func (c *Network) String() string
  • func (c *Network) TrySend(chID byte, msgBytes []byte) bool
• type SecretConnection
  • func MakeSecretConnection(conn io.ReadWriteCloser, locPrivKey crypto.PrivKey) (*SecretConnection, error)
  • func (sc *SecretConnection) Close() error
  • func (sc *SecretConnection) LocalAddr() net.Addr
  • func (sc *SecretConnection) Read(data []byte) (n int, err error)
  • func (sc *SecretConnection) RemoteAddr() net.Addr
  • func (sc *SecretConnection) RemotePubKey() crypto.PubKey
  • func (sc *SecretConnection) SetDeadline(t time.Time) error
  • func (sc *SecretConnection) SetReadDeadline(t time.Time) error
  • func (sc *SecretConnection) SetWriteDeadline(t time.Time) error
  • func (sc *SecretConnection) Write(data []byte) (n int, err error)

Variables

var (
	ErrSmallOrderRemotePubKey = errors.New("detected low order point from remote peer")
)

Functions

func NetPipe

func NetPipe() (net.Conn, net.Conn)

Types

type Channel

type Channel struct {
	Logger log.Logger
	// contains filtered or unexported fields
}

TODO: lowercase. NOTE: not goroutine-safe.

func (*Channel) SetLogger

func (ch *Channel) SetLogger(l log.Logger)

type ChannelDescriptor

type ChannelDescriptor struct {
	ID                  byte
	Priority            int
	SendQueueCapacity   int
	RecvBufferCapacity  int
	RecvMessageCapacity int
	MessageType         proto.Message
}

func (ChannelDescriptor) FillDefaults

func (chDesc ChannelDescriptor) FillDefaults() (filled ChannelDescriptor)

type ChannelStatus

type ChannelStatus struct {
	ID                byte
	SendQueueCapacity int
	SendQueueSize     int
	Priority          int
	RecentlySent      int64
}

type ConnectionStatus

type ConnectionStatus struct {
	Duration    time.Duration
	SendMonitor flow.Status
	RecvMonitor flow.Status
	Channels    []ChannelStatus
}

type MConnConfig

type MConnConfig struct {
	SendRate int64 `mapstructure:"send_rate"`
	RecvRate int64 `mapstructure:"recv_rate"`

	// Maximum payload size
	MaxPacketMsgPayloadSize int `mapstructure:"max_packet_msg_payload_size"`

	// Interval to flush writes (throttled)
	FlushThrottle time.Duration `mapstructure:"flush_throttle"`

	// Interval to send pings
	PingInterval time.Duration `mapstructure:"ping_interval"`

	// Maximum wait time for pongs
	PongTimeout time.Duration `mapstructure:"pong_timeout"`
}

MConnConfig is a Network configuration.

func DefaultMConnConfig

func DefaultMConnConfig() MConnConfig

DefaultMConnConfig returns the default config.

type Network

type Network struct {
	service.BaseService
	// contains filtered or unexported fields
}

Each peer has one `Network` (multiplex connection) instance.

__multiplex__ *noun* a system or signal involving simultaneous transmission of several messages along a single channel of communication.

Each `Network` handles message transmission on multiple abstract communication `Channel`s. Each channel has a globally unique byte id. The byte id and the relative priorities of each `Channel` are configured upon initialization of the connection.

There are two methods for sending messages:

func (m Network) Send(chID byte, msgBytes []byte) bool {}
func (m Network) TrySend(chID byte, msgBytes []byte}) bool {}

`Send(chID, msgBytes)` is a blocking call that waits until `msg` is successfully queued for the channel with the given id byte `chID`, or until the request times out. The message `msg` is serialized using Protobuf.

`TrySend(chID, msgBytes)` is a nonblocking call that returns false if the channel's queue is full.

Inbound message bytes are handled with an onReceive callback function.

func NewNetwork

func NewNetwork(
	conn net.Conn,
	chDescs []*ChannelDescriptor,
	onReceive receiveCbFunc,
	onError errorCbFunc,
) *Network

NewNetwork wraps net.Conn and creates multiplex connection

func NewNetworkWithConfig

func NewNetworkWithConfig(
	conn net.Conn,
	chDescs []*ChannelDescriptor,
	onReceive receiveCbFunc,
	onError errorCbFunc,
	config MConnConfig,
) *Network

NewNetworkWithConfig wraps net.Conn and creates multiplex connection with a config

func (*Network) CanSend

func (c *Network) CanSend(chID byte) bool

CanSend returns true if you can send more data onto the chID, false otherwise. Use only as a heuristic.

func (*Network) FlushStop

func (c *Network) FlushStop()

FlushStop replicates the logic of OnStop. It additionally ensures that all successful .Send() calls will get flushed before closing the connection.

func (*Network) OnStart

func (c *Network) OnStart() error

OnStart implements BaseService

func (*Network) OnStop

func (c *Network) OnStop()

OnStop implements BaseService

func (*Network) Send

func (c *Network) Send(chID byte, msgBytes []byte) bool

Queues a message to be sent to channel.

func (*Network) SetLogger

func (c *Network) SetLogger(l log.Logger)

func (*Network) Status

func (c *Network) Status() ConnectionStatus

func (*Network) String

func (c *Network) String() string

func (*Network) TrySend

func (c *Network) TrySend(chID byte, msgBytes []byte) bool

Queues a message to be sent to channel. Nonblocking, returns true if successful.

type SecretConnection

type SecretConnection struct {
	// contains filtered or unexported fields
}

SecretConnection implements net.Conn. It is an implementation of the STS protocol. See https://github.com/bsiadmin/tecrepo/blob/0.1/docs/sts-final.pdf for details on the protocol.

Consumers of the SecretConnection are responsible for authenticating the remote peer's pubkey against known information, like a nodeID. Otherwise they are vulnerable to MITM. (TODO(ismail): see also https://github.com/tendermint/tendermint/issues/3010)

func MakeSecretConnection

func MakeSecretConnection(conn io.ReadWriteCloser, locPrivKey crypto.PrivKey) (*SecretConnection, error)

MakeSecretConnection performs handshake and returns a new authenticated SecretConnection. Returns nil if there is an error in handshake. Caller should call conn.Close() See docs/sts-final.pdf for more information.

func (*SecretConnection) Close

func (sc *SecretConnection) Close() error

Implements net.Conn

func (*SecretConnection) LocalAddr

func (sc *SecretConnection) LocalAddr() net.Addr

func (*SecretConnection) Read

func (sc *SecretConnection) Read(data []byte) (n int, err error)

CONTRACT: data smaller than dataMaxSize is read atomically.

func (*SecretConnection) RemoteAddr

func (sc *SecretConnection) RemoteAddr() net.Addr

func (*SecretConnection) RemotePubKey

func (sc *SecretConnection) RemotePubKey() crypto.PubKey

RemotePubKey returns authenticated remote pubkey

func (*SecretConnection) SetDeadline

func (sc *SecretConnection) SetDeadline(t time.Time) error

func (*SecretConnection) SetReadDeadline

func (sc *SecretConnection) SetReadDeadline(t time.Time) error

func (*SecretConnection) SetWriteDeadline

func (sc *SecretConnection) SetWriteDeadline(t time.Time) error

func (*SecretConnection) Write

func (sc *SecretConnection) Write(data []byte) (n int, err error)

Writes encrypted frames of `totalFrameSize + aeadSizeOverhead`. CONTRACT: data smaller than dataMaxSize is written atomically.