p2p

Documentation

Index

• func NOPHandshakeFunc(_ Peer) error
• type Decoder
• type DefaultDecoder
  • func (dec DefaultDecoder) Decode(r io.Reader, rpc *RPC) error
• type GOBDecoder
  • func (dec GOBDecoder) Decode(r io.Reader, rpc *RPC) error
• type HandshakeFunc
• type Peer
  • func NewTCPPeer(conn net.Conn, outbound bool) Peer
• type RPC
• type TCPTransportOpts
• type Transport
  • func NewTCPTransport(opts TCPTransportOpts) Transport

Functions

func NOPHandshakeFunc

func NOPHandshakeFunc(_ Peer) error

Types

type Decoder

type Decoder interface {
	Decode(r io.Reader, rpc *RPC) error
}

type DefaultDecoder

type DefaultDecoder struct{}

func (DefaultDecoder) Decode

func (dec DefaultDecoder) Decode(r io.Reader, rpc *RPC) error

type GOBDecoder

type GOBDecoder struct{}

func (GOBDecoder) Decode

func (dec GOBDecoder) Decode(r io.Reader, rpc *RPC) error

type HandshakeFunc

type HandshakeFunc func(peer Peer) error

type Peer

type Peer interface {
	Close() error
}

Peer is an interface that represents the remote node.

func NewTCPPeer

func NewTCPPeer(conn net.Conn, outbound bool) Peer

type RPC

type RPC struct {
	From    net.Addr
	Payload []byte
}

Message represents any arbitrary data that is being sent over each transport between two nodes in the network.

type TCPTransportOpts

type TCPTransportOpts struct {
	ListenAddr    string
	HandshakeFunc HandshakeFunc
	Decoder
	OnPeer func(peer Peer) error
}

type Transport

type Transport interface {
	ListenAndAccept() error
	Consume() <-chan RPC
}

Transport is anything that handles the communication between the nodes in the network. This can be of the form (TCP, UDP, websockets, ...)

func NewTCPTransport

func NewTCPTransport(opts TCPTransportOpts) Transport