p2p

Documentation

Overview

Package p2p implements a TCP based perfect peer-to-peer link.

Index

• Variables
• func WithChannel(channel string) func(*Node)
• func WithKeepAlive(keepAlive time.Duration) func(*Node)
• func WithNode(node link.Node) func(*Node)
• type Node
  • func New(configs ...func(*Node)) *Node
  • func (n *Node) Deliver(f func(p link.Peer, m link.Message))
  • func (n *Node) Send(q link.Peer, m link.Message) error
• type Payload

Variables

var WithDefault = func(n *Node) {
	n.Node = node.New(node.WithDefault)
}

WithDefault can be used to instantiate a new node with default options.

Functions

func WithChannel

func WithChannel(channel string) func(*Node)

WithChannel sets the RPC channel name when instantiating a new p2p node.

func WithKeepAlive

func WithKeepAlive(keepAlive time.Duration) func(*Node)

WithKeepAlive sets the TCP keepalive when instantiating a new p2p node (e.g. New(WithKeepAlive(1 * time.Seconds), ...)).

func WithNode

func WithNode(node link.Node) func(*Node)

WithNode sets the node when instantiating a new p2p node (e.g. New(WithNode(n), ...)).

Types

type Node

type Node struct {
	link.Node
	// contains filtered or unexported fields
}

Node implements perfect peer-to-peer link.

func New

func New(configs ...func(*Node)) *Node

New instantiates a new TCP based perfect peer-to-peer link.

func (*Node) Deliver

func (n *Node) Deliver(f func(p link.Peer, m link.Message))

Deliver registers the deliver handler.

func (*Node) Send

func (n *Node) Send(q link.Peer, m link.Message) error

Send requests to send message m to process q.

type Payload

type Payload struct {
	ID      string
	Addr    net.Addr
	Message link.Message
}

Payload wraps the message and the ID of the sender.