transport

Documentation

Index

• type Acceptor
• type Addr
• type Buffers
• type BuffersWriter
• type Factory
• type Option
  • func WithAttachment(attachment interface{}) Option
  • func WithContext(ctx context.Context) Option
• type Options
  • func ParseOptions(ctx context.Context, url string, options ...Option) (*Options, error)
  • func (lo *Options) AddressWithoutHost() string
  • func (lo *Options) Apply(options ...Option) error
• type Schemes
  • func (ss Schemes) Add(scheme string) Schemes
  • func (ss Schemes) FixScheme(u *url.URL) error
  • func (ss Schemes) Valid(scheme string) bool
  • func (ss Schemes) ValidURL(address string) bool
• type Transport
  • func NewTransport(conn net.Conn, readSize, writeSize int) Transport

Types

type Acceptor

type Acceptor interface {
	Accept() (Transport, error)
	Close() error
}

Acceptor defines transport acceptor

type Addr

type Addr = net.Addr

Addr alias to net.Addr

type Buffers

type Buffers = net.Buffers

Buffers to optimize message merging

type BuffersWriter

type BuffersWriter interface {
	Writev(buffs Buffers) (int64, error)
}

BuffersWriter defines writev for optimized syscall

type Factory

type Factory interface {

	// Schemes supported schemes.
	Schemes() Schemes

	// Connect to the peer with the specified address.
	Connect(options *Options) (Transport, error)

	// Listen for an address and accept the connection request.
	Listen(options *Options) (Acceptor, error)
}

Factory defines transport factory

type Option

type Option func(options *Options) error

Option defines option function

func WithAttachment

func WithAttachment(attachment interface{}) Option

WithAttachment a data associated with the Channel

func WithContext

func WithContext(ctx context.Context) Option

WithContext to hold other configure pass by context.WithValue

type Options

type Options struct {
	// In server side: listen address.
	// In client side: connect address.
	Address *url.URL

	// Other configure pass by context.WithValue
	Context context.Context

	// Attachment defines the object or data associated with the Channel
	Attachment interface{}
}

Options for transport

func ParseOptions

func ParseOptions(ctx context.Context, url string, options ...Option) (*Options, error)

ParseOptions parse options

func (*Options) AddressWithoutHost

func (lo *Options) AddressWithoutHost() string

AddressWithoutHost convert host:port to :port

func (*Options) Apply

func (lo *Options) Apply(options ...Option) error

Apply options

type Schemes

type Schemes []string

Schemes to define scheme list

func (Schemes) Add

func (ss Schemes) Add(scheme string) Schemes

Add scheme

func (Schemes) FixScheme

func (ss Schemes) FixScheme(u *url.URL) error

FixScheme to fix scheme

func (Schemes) Valid

func (ss Schemes) Valid(scheme string) bool

Valid scheme

func (Schemes) ValidURL

func (ss Schemes) ValidURL(address string) bool

ValidURL to check url scheme

type Transport

type Transport interface {
	net.Conn

	// BuffersWriter for optimized syscall
	BuffersWriter

	// Flush flush buffer.
	Flush() error

	// RawTransport raw transport object.
	RawTransport() interface{}
}

Transport defines a transport

func NewTransport

func NewTransport(conn net.Conn, readSize, writeSize int) Transport