p2p

Documentation

Index

• Constants
• Variables
• func NOPHandshakeFunc(Peer) error
• type Decoder
• type DefaultDecoder
  • func (dec DefaultDecoder) Decode(r io.Reader, msg *RPC) error
• type GODecoder
  • func (dec GODecoder) Decode(r io.Reader, msg *RPC) error
• type HandshakeFunc
• type Peer
• type RPC
• type TCPPeer
  • func NewTCPPeer(conn net.Conn, outbound bool) *TCPPeer
  • func (p *TCPPeer) CloseStream()
  • func (p *TCPPeer) Send(b []byte) error
• type TCPTransport
  • func NewTCPTransport(opts TCPTransportOpts) *TCPTransport
  • func (t *TCPTransport) Addr() string
  • func (t *TCPTransport) Close() error
  • func (t *TCPTransport) Consume() <-chan RPC
  • func (t *TCPTransport) Dial(addr string) error
  • func (t *TCPTransport) ListenAndAccept() error
• type TCPTransportOpts
• type Transport

Constants

const (
	IncomingMessage = 0x1
	IncomingStream  = 0x2
)

Variables

var ErrInvalidHandshake = errors.New("invalid handshake")

Functions

func NOPHandshakeFunc

func NOPHandshakeFunc(Peer) error

Types

type Decoder

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

type DefaultDecoder

type DefaultDecoder struct{}

func (DefaultDecoder) Decode

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

type GODecoder

type GODecoder struct{}

func (GODecoder) Decode

func (dec GODecoder) Decode(r io.Reader, msg *RPC) error

type HandshakeFunc

type HandshakeFunc func(Peer) error

type Peer

type Peer interface {
	net.Conn
	Send([]byte) error
	CloseStream()
}

// Peer is an intefrace that represents the remote node

type RPC

type RPC struct {
	From    string
	Payload []byte
	Stream  bool
}

RPC holds any arbitrary data that is being sent over each transports between two nodes in the network.

type TCPPeer

type TCPPeer struct {
	// The underlying connection of the peer. Which in this case
	// is a TCP connection
	net.Conn
	// contains filtered or unexported fields
}

TCPPeer represents the remote node over TCP established connection.

func NewTCPPeer

func NewTCPPeer(conn net.Conn, outbound bool) *TCPPeer

func (*TCPPeer) CloseStream

func (p *TCPPeer) CloseStream()

func (*TCPPeer) Send

func (p *TCPPeer) Send(b []byte) error

Send writes the byte function, that will send the data to connection

type TCPTransport

type TCPTransport struct {
	TCPTransportOpts
	// contains filtered or unexported fields
}

func NewTCPTransport

func NewTCPTransport(opts TCPTransportOpts) *TCPTransport

func (*TCPTransport) Addr

func (t *TCPTransport) Addr() string

Addr implements the Transport interface return the address the transport is accepting connections.

func (*TCPTransport) Close

func (t *TCPTransport) Close() error

Close implements the Transport interface.

func (*TCPTransport) Consume

func (t *TCPTransport) Consume() <-chan RPC

Consume implements the Transport interface, which will return read-only channel for reading the incoming messages received from another peer in the network.

func (*TCPTransport) Dial

func (t *TCPTransport) Dial(addr string) error

Dial Implements Transport Interface

func (*TCPTransport) ListenAndAccept

func (t *TCPTransport) ListenAndAccept() error

type TCPTransportOpts

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

type Transport

type Transport interface {
	Addr() string
	Dial(string) error
	ListenAndAccept() error
	Consume() <-chan RPC
	Close() error
}

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