transport

Documentation

Index

• Variables
• type FrameHandshake
  • func NewFrameHandshakeFromTransport(t TransportMsg) *FrameHandshake
  • func (fh *FrameHandshake) Close() error
  • func (fh *FrameHandshake) ReadMsg(timeout time.Duration) ([]byte, error)
  • func (fh *FrameHandshake) WriteMsg(payload []byte) error
• type FramedStream
  • func NewFramedStreamFromTransport(t Transport) *FramedStream
  • func (fs *FramedStream) Close() error
  • func (fs *FramedStream) ReadMsg(timeout time.Duration) ([]byte, error)
  • func (fs *FramedStream) WriteMsg(payload []byte) error
• type MsgStream
• type Transport
• type TransportMsg

Variables

var ErrClosed = errors.New("socket closed")

var ErrTimeout = errors.New("socket timeout")

Timeout error

Types

type FrameHandshake

type FrameHandshake struct {
	Trans TransportMsg
	// contains filtered or unexported fields
}

FrameHandshake represents a stream with message semantics

func NewFrameHandshakeFromTransport

func NewFrameHandshakeFromTransport(t TransportMsg) *FrameHandshake

NewFrameHandshakeFromTransport creates a message stream from transport t

func (*FrameHandshake) Close

func (fh *FrameHandshake) Close() error

Close closes the transport stream

func (*FrameHandshake) ReadMsg

func (fh *FrameHandshake) ReadMsg(timeout time.Duration) ([]byte, error)

ReadMsg reads a io4edge standard message from transport without timeout

func (*FrameHandshake) WriteMsg

func (fh *FrameHandshake) WriteMsg(payload []byte) error

WriteMsg writes io4edge standard message to the transport stream

type FramedStream

type FramedStream struct {
	Trans Transport
	// contains filtered or unexported fields
}

FramedStream represents a stream with message semantics

func NewFramedStreamFromTransport

func NewFramedStreamFromTransport(t Transport) *FramedStream

NewFramedStreamFromTransport creates a message stream from transport t

func (*FramedStream) Close

func (fs *FramedStream) Close() error

Close closes the transport stream

func (*FramedStream) ReadMsg

func (fs *FramedStream) ReadMsg(timeout time.Duration) ([]byte, error)

ReadMsg reads a io4edge standard message from transport stream

func (*FramedStream) WriteMsg

func (fs *FramedStream) WriteMsg(payload []byte) error

WriteMsg writes io4edge standard message to the transport stream

type MsgStream

type MsgStream interface {
	ReadMsg(timeout time.Duration) ([]byte, error)
	WriteMsg(payload []byte) (err error)
	Close() error
}

MsgStream is the interface used by a Channel to exchange message frames with the transport layer e.g. socket, websocket...

type Transport

type Transport interface {
	Read(p []byte) (n int, err error)
	Write(p []byte) (n int, err error)
	SetReadDeadline(t time.Time) error
	Close() error
}

Transport is the interface used by message stream to communicate with the underlying transport layer e.g. tcp sockets

type TransportMsg

type TransportMsg interface {
	Read(p []byte) (n int, err error)
	Write(p []byte) (n int, err error)
	SetReadDeadline(t time.Time) error
	Close() error
}

TransportMsg is the interface used by message stream to communicate with the underlying transport layer e.g. udp sockets