frameconn

package

v0.1.1 Latest Latest Go to latest Published: Apr 6, 2019 License: MIT Imports: 11 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.com/calistoc/zrepl

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func IsPublicFrameType(ft uint32) bool
func PrometheusRegister(registry prometheus.Registerer) error
type Buffer
- func (b *Buffer) Bytes() []byte
- func (b *Buffer) Free()
type Conn
- func Wrap(nc timeoutconn.Conn) *Conn
type Frame
type FrameHeader
- func (f *FrameHeader) Unmarshal(buf []byte)

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrFixedFrameLengthMismatch = errors.New("read frame length mismatch")

View Source

var ErrReadFrameLengthShort = errors.New("read frame length too short")

View Source

var ErrShutdown = fmt.Errorf("frameconn: shutting down")

Functions ¶

func IsPublicFrameType ¶

func IsPublicFrameType(ft uint32) bool

The 4 MSBs of ft are reserved for frameconn.

func PrometheusRegister ¶

func PrometheusRegister(registry prometheus.Registerer) error

Types ¶

type Buffer ¶

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

func (*Buffer) Bytes ¶

func (b *Buffer) Bytes() []byte

func (*Buffer) Free ¶

func (b *Buffer) Free()

type Conn ¶

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

func Wrap ¶

func Wrap(nc timeoutconn.Conn) *Conn

func (*Conn) ReadFrame ¶

func (c *Conn) ReadFrame() (Frame, error)

ReadFrame reads a frame from the connection.

Due to an internal optimization (Readv, specifically), it is not guaranteed that a single call to WriteFrame unblocks a pending ReadFrame on an otherwise idle (empty) connection. The only way to guarantee that all previously written frames can reach the peer's layers on top of frameconn is to send an empty frame (no payload) and to ignore empty frames on the receiving side.

func (*Conn) ResetWriteTimeout ¶ added in v0.1.1

func (c *Conn) ResetWriteTimeout() error

func (*Conn) Shutdown ¶

func (c *Conn) Shutdown(deadline time.Time) error

func (*Conn) WriteFrame ¶

func (c *Conn) WriteFrame(payload []byte, frameType uint32) error

type Frame ¶

type Frame struct {
	Header FrameHeader
	Buffer Buffer
}

type FrameHeader ¶

type FrameHeader struct {
	Type       uint32
	PayloadLen uint32
}

func (*FrameHeader) Unmarshal ¶

func (f *FrameHeader) Unmarshal(buf []byte)

Source Files ¶

View all Source files

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