net

Documentation

Index

• Variables
• func Addresses() []string
• func GetAddresses(protocol string, l net.Listener) []string
• func GetLocalPeerAddresses(port int) ([]string, error)
• func Read(conn *Connection) (*object.Object, error)
• func WithEventBus(k eventbus.Eventbus) func(*network)
• func WithKeychain(k keychain.Keychain) func(*network)
• func Write(o object.Object, conn *Connection) error
• type Connection
  • func Accept() (*Connection, error)
  • func Dial(ctx context.Context, p *peer.Peer) (*Connection, error)
  • func (c *Connection) Close() error
  • func (c *Connection) LocalAddr() string
  • func (c *Connection) RemoteAddr() string
• type Listener
  • func Listen(ctx context.Context, bindAddress string) (Listener, error)
• type Middleware
• type MiddlewareHandler
• type Network
  • func New(opts ...Option) Network
• type Option
• type 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")
	// ErrMissingSignature is when the signature is missing
	ErrMissingSignature = errors.New("signature missing")
	// ErrAllAddressesBlacklisted all peer's addresses are currently blacklisted
	ErrAllAddressesBlacklisted = errors.New("all addresses blacklisted")
)

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

)

var (
	DefaultNetwork = New(
		WithEventBus(eventbus.DefaultEventbus),
		WithKeychain(keychain.DefaultKeychain),
	)
)

Functions

func Addresses

func Addresses() []string

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 WithEventBus

func WithEventBus(k eventbus.Eventbus) func(*network)

WithEventBus overrides the default eventbus for the network.

func WithKeychain

func WithKeychain(k keychain.Keychain) func(*network)

WithKeychain overrides the default keychain for the network.

func Write

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

Types

type Connection

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

func Accept

func Accept() (*Connection, error)

func Dial

func Dial(
	ctx context.Context,
	p *peer.Peer,
) (*Connection, error)

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 Listener

type Listener interface {
	Close() error
	Addresses() []string
}

func Listen

func Listen(
	ctx context.Context,
	bindAddress string,
) (Listener, error)

type Middleware

type Middleware interface {
	Handle() MiddlewareHandler
}

Middleware defines a middleware interface

type MiddlewareHandler

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

MiddlewareHandler defines a middleware handler

type Network

type Network interface {
	Dial(
		ctx context.Context,
		peer *peer.Peer,
	) (*Connection, error)
	Listen(
		ctx context.Context,
		bindAddress string,
	) (Listener, error)
	Accept() (*Connection, error)
	Addresses() []string
}

Network interface

func New

func New(opts ...Option) Network

New creates a new p2p network

type Option

type Option func(*network)

Option for customizing a new network

type Transport

type Transport interface {
	Dial(
		ctx context.Context,
		address string,
	) (*Connection, error)
	Listen(
		ctx context.Context,
		bindAddress string,
		key crypto.PrivateKey,
	) (net.Listener, error)
}