transport

Documentation

Index

• Constants
• Variables
• func ParseScheme(addr string) (scheme string)
• func RegisterTransport(t Transport)
• func RegisterTransportWithScheme(t Transport, scheme string)
• func ResolveTCPAddr(addr string) (*net.TCPAddr, error)
• func StripScheme(t Transport, addr string) (a string, err error)
• type Address
  • func NewAddress(scheme, addr string) *Address
  • func (a *Address) Network() string
  • func (a *Address) String() string
• type Connection
  • func NewConnection(transport Transport, nc net.Conn, accepted bool) (Connection, error)
• type Dialer
• type Listener
• type Transport
  • func GetTransport(scheme string) Transport
  • func GetTransportFromAddr(addr string) Transport

Constants

const (
	ErrConnRefused  = errs.Err("connection refused")
	ErrNotListening = errs.Err("not listening")
)

errors

Variables

var (
	// OptionDomains is option's domain
	OptionDomains = []string{"transport"}
	// Options for transport
	Options = transportOptions{}
)

Functions

func ParseScheme

func ParseScheme(addr string) (scheme string)

ParseScheme parse scheme from address

func RegisterTransport

func RegisterTransport(t Transport)

RegisterTransport is used to register the transport globally, after which it will be available for all sockets. The transport will override any others registered for the same scheme.

func RegisterTransportWithScheme

func RegisterTransportWithScheme(t Transport, scheme string)

RegisterTransportWithScheme register transport as an alias scheme

func ResolveTCPAddr

func ResolveTCPAddr(addr string) (*net.TCPAddr, error)

ResolveTCPAddr is like net.ResolveTCPAddr, but it handles the wildcard used in nanomsg URLs, replacing it with an empty string to indicate that all local interfaces be used.

func StripScheme

func StripScheme(t Transport, addr string) (a string, err error)

StripScheme removes the leading scheme (such as "http://") from an address string. This is mostly a utility for benefit of transport providers.

Types

type Address

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

Address is transport Connection's address as net.Addr

func NewAddress

func NewAddress(scheme, addr string) *Address

NewAddress create an address

func (*Address) Network

func (a *Address) Network() string

Network address's network

func (*Address) String

func (a *Address) String() string

Network address's value

type Connection

type Connection interface {
	Transport() Transport
	net.Conn
	Writev(v ...[]byte) (int64, error)
	LocalAddress() string
	RemoteAddress() string
	RawConn() net.Conn
}

Connection is connection between peers.

func NewConnection

func NewConnection(transport Transport, nc net.Conn, accepted bool) (Connection, error)

NewConnection allocates a new Connection using the net.Conn

type Dialer

type Dialer interface {
	Dial(opts options.Options) (Connection, error)
}

Dialer is dialer

type Listener

type Listener interface {
	Listen(opts options.Options) error
	Accept(opts options.Options) (Connection, error)
	Close() error
}

Listener is listener

type Transport

type Transport interface {
	Scheme() string
	NewDialer(address string) (Dialer, error)
	NewListener(address string) (Listener, error)
}

Transport is transport

func GetTransport

func GetTransport(scheme string) Transport

GetTransport is used by a socket to lookup the transport for a given scheme.

func GetTransportFromAddr

func GetTransportFromAddr(addr string) Transport

GetTransportFromAddr get transport for the address scheme