net

Documentation

Index

• Variables
• func GetAddresses(protocol string, l net.Listener) []string
• func GetLocalPeerAddresses(port int) ([]string, error)
• func Read(conn *Connection) (object.Object, error)
• func Write(o object.Object, conn *Connection) error
• type Connection
  • func (c *Connection) Close() error
  • func (c *Connection) LocalAddr() string
  • func (c *Connection) RemoteAddr() string
• type Middleware
• type MiddlewareHandler
• type Network
  • func New(discover discovery.Discoverer, local *peer.LocalPeer) (Network, error)
• type Option
  • func WithLocalDiscoveryOnly() Option
• type Options
• type Transport
  • func NewHTTPTransport(local *peer.LocalPeer, address string) Transport
  • func NewTCPTransport(local *peer.LocalPeer, address string) Transport

Variables

var (
	// ErrAllAddressesFailed for when a peer cannot be dialed
	ErrAllAddressesFailed = errors.New("all addresses failed to dial")
	// ErrNoAddresses for when a peer has no addresses
	ErrNoAddresses = errors.New("no addresses")
	// ErrNotForUs object is not meant for us
	ErrNotForUs = errors.New("object not for us")
	// ErrMissingKey when a key is not passed
	ErrMissingKey = errors.New("missing key")
	// ErrECDSAPrivateKeyRequired when a key is not an ECDSA key
	ErrECDSAPrivateKeyRequired = errors.New(
		"network currently requires an ecdsa private key")
	// ErrNonce is when the nonce does not match
	ErrNonce = errors.New("nonce does not match")
)

var (
	BindLocal = false // TODO(geoah) refactor to remove global

)

var (
	UseUPNP = false
)

Functions

func GetAddresses

func GetAddresses(protocol string, l net.Listener) []string

GetAddresses returns the addresses the transport is listening to

func GetLocalPeerAddresses

func GetLocalPeerAddresses(port int) ([]string, error)

GetLocalPeerAddresses returns the addresses TCP can listen to on the local machine

func Read

func Read(conn *Connection) (object.Object, error)

func Write

func Write(o object.Object, conn *Connection) error

Types

type Connection

type Connection struct {
	RemotePeerKey *crypto.PublicKey
	IsIncoming    bool
	// contains filtered or unexported fields
}

func (*Connection) Close

func (c *Connection) Close() error

func (*Connection) LocalAddr

func (c *Connection) LocalAddr() string

func (*Connection) RemoteAddr

func (c *Connection) RemoteAddr() string

type Middleware

type Middleware interface {
	Handle() MiddlewareHandler
}

Middleware ...

type MiddlewareHandler

type MiddlewareHandler func(ctx context.Context,
	conn *Connection) (*Connection, error)

MiddlewareHandler ...

type Network

type Network interface {
	Dial(ctx context.Context, address string, options ...Option) (*Connection, error)
	Listen(ctx context.Context) (chan *Connection, error)

	AddMiddleware(handler MiddlewareHandler)
	AddTransport(tag string, tsp Transport)
}

Network interface

func New

func New(discover discovery.Discoverer, local *peer.LocalPeer) (Network, error)

New creates a new p2p network using an address book

type Option

type Option func(*Options)

func WithLocalDiscoveryOnly

func WithLocalDiscoveryOnly() Option

type Options

type Options struct {
	LocalDiscoveryOnly bool
}

Options (mostly) for Dial()

type Transport

type Transport interface {
	Dial(ctx context.Context, address string) (*Connection, error)
	Listen(ctx context.Context) (chan *Connection, error)
}

func NewHTTPTransport

func NewHTTPTransport(
	local *peer.LocalPeer,
	address string,
) Transport

func NewTCPTransport

func NewTCPTransport(
	local *peer.LocalPeer,
	address string,
) Transport