p2p

Documentation

Index

• Variables
• func EncodeMsg(w MsgWriter, code uint64, data ...interface{}) error
• func MakeName(name, version string) string
• func MsgPipe() (*MsgPipeRW, *MsgPipeRW)
• type Blacklist
• type BlacklistMap
  • func NewBlacklist() *BlacklistMap
  • func (self *BlacklistMap) Delete(pubkey []byte) error
  • func (self *BlacklistMap) Exists(pubkey []byte) (ok bool)
  • func (self *BlacklistMap) Get(pubkey []byte) (bool, error)
  • func (self *BlacklistMap) Put(pubkey []byte) error
• type Cap
  • func (cap Cap) RlpData() interface{}
  • func (cap Cap) String() string
• type DiscReason
  • func (d DiscReason) String() string
• type Msg
  • func NewMsg(code uint64, params ...interface{}) Msg
  • func (msg Msg) Decode(val interface{}) error
  • func (msg Msg) Discard() error
  • func (msg Msg) String() string
• type MsgPipeRW
  • func (p *MsgPipeRW) Close() error
  • func (p *MsgPipeRW) ReadMsg() (Msg, error)
  • func (p *MsgPipeRW) WriteMsg(msg Msg) error
• type MsgReadWriter
• type MsgReader
• type MsgWriter
• type Peer
  • func NewPeer(id discover.NodeID, name string, caps []Cap) *Peer
  • func (p *Peer) Caps() []Cap
  • func (p *Peer) Disconnect(reason DiscReason)
  • func (p *Peer) ID() discover.NodeID
  • func (p *Peer) LocalAddr() net.Addr
  • func (p *Peer) Name() string
  • func (p *Peer) RemoteAddr() net.Addr
  • func (p *Peer) String() string
• type Protocol
• type Server
  • func (srv *Server) Broadcast(protocol string, code uint64, data ...interface{})
  • func (srv *Server) PeerCount() int
  • func (srv *Server) Peers() (peers []*Peer)
  • func (srv *Server) Start() (err error)
  • func (srv *Server) Stop()
  • func (srv *Server) SuggestPeer(n *discover.Node)

Examples

• MsgPipe

Variables

var ErrPipeClosed = errors.New("p2p: read or write on closed message pipe")

ErrPipeClosed is returned from pipe operations after the pipe has been closed.

Functions

func EncodeMsg

func EncodeMsg(w MsgWriter, code uint64, data ...interface{}) error

EncodeMsg writes an RLP-encoded message with the given code and data elements.

func MakeName

func MakeName(name, version string) string

MakeName creates a node name that follows the ethereum convention for such names. It adds the operation system name and Go runtime version the name.

func MsgPipe

func MsgPipe() (*MsgPipeRW, *MsgPipeRW)

MsgPipe creates a message pipe. Reads on one end are matched with writes on the other. The pipe is full-duplex, both ends implement MsgReadWriter.

Example

rw1, rw2 := MsgPipe()
go func() {
	EncodeMsg(rw1, 8, []byte{0, 0})
	EncodeMsg(rw1, 5, []byte{1, 1})
	rw1.Close()
}()

for {
	msg, err := rw2.ReadMsg()
	if err != nil {
		break
	}
	var data [1][]byte
	msg.Decode(&data)
	fmt.Printf("msg: %d, %x\n", msg.Code, data[0])
}

Output:

msg: 8, 0000
msg: 5, 0101

Types

type Blacklist

type Blacklist interface {
	Get([]byte) (bool, error)
	Put([]byte) error
	Delete([]byte) error
	Exists(pubkey []byte) (ok bool)
}

type BlacklistMap

type BlacklistMap struct {
	// contains filtered or unexported fields
}

func NewBlacklist

func NewBlacklist() *BlacklistMap

func (*BlacklistMap) Delete

func (self *BlacklistMap) Delete(pubkey []byte) error

func (*BlacklistMap) Exists

func (self *BlacklistMap) Exists(pubkey []byte) (ok bool)

func (*BlacklistMap) Get

func (self *BlacklistMap) Get(pubkey []byte) (bool, error)

func (*BlacklistMap) Put

func (self *BlacklistMap) Put(pubkey []byte) error

type Cap

type Cap struct {
	Name    string
	Version uint
}

Cap is the structure of a peer capability.

func (Cap) RlpData

func (cap Cap) RlpData() interface{}

func (Cap) String

func (cap Cap) String() string

type DiscReason

type DiscReason byte

const (
	DiscRequested DiscReason = iota
	DiscNetworkError
	DiscProtocolError
	DiscUselessPeer
	DiscTooManyPeers
	DiscAlreadyConnected
	DiscIncompatibleVersion
	DiscInvalidIdentity
	DiscQuitting
	DiscUnexpectedIdentity
	DiscSelf
	DiscReadTimeout
	DiscSubprotocolError
)

func (DiscReason) String

func (d DiscReason) String() string

type Msg

type Msg struct {
	Code    uint64
	Size    uint32 // size of the paylod
	Payload io.Reader
}

Msg defines the structure of a p2p message.

Note that a Msg can only be sent once since the Payload reader is consumed during sending. It is not possible to create a Msg and send it any number of times. If you want to reuse an encoded structure, encode the payload into a byte array and create a separate Msg with a bytes.Reader as Payload for each send.

func NewMsg

func NewMsg(code uint64, params ...interface{}) Msg

NewMsg creates an RLP-encoded message with the given code.

func (Msg) Decode

func (msg Msg) Decode(val interface{}) error

Decode parse the RLP content of a message into the given value, which must be a pointer.

For the decoding rules, please see package rlp.

func (Msg) Discard

func (msg Msg) Discard() error

Discard reads any remaining payload data into a black hole.

func (Msg) String

func (msg Msg) String() string

type MsgPipeRW

type MsgPipeRW struct {
	// contains filtered or unexported fields
}

MsgPipeRW is an endpoint of a MsgReadWriter pipe.

func (*MsgPipeRW) Close

func (p *MsgPipeRW) Close() error

Close unblocks any pending ReadMsg and WriteMsg calls on both ends of the pipe. They will return ErrPipeClosed. Note that Close does not interrupt any reads from a message payload.

func (*MsgPipeRW) ReadMsg

func (p *MsgPipeRW) ReadMsg() (Msg, error)

ReadMsg returns a message sent on the other end of the pipe.

func (*MsgPipeRW) WriteMsg

func (p *MsgPipeRW) WriteMsg(msg Msg) error

WriteMsg sends a messsage on the pipe. It blocks until the receiver has consumed the message payload.

type MsgReadWriter

type MsgReadWriter interface {
	MsgReader
	MsgWriter
}

MsgReadWriter provides reading and writing of encoded messages. Implementations should ensure that ReadMsg and WriteMsg can be called simultaneously from multiple goroutines.

type MsgReader

type MsgReader interface {
	ReadMsg() (Msg, error)
}

type MsgWriter

type MsgWriter interface {
	// WriteMsg sends a message. It will block until the message's
	// Payload has been consumed by the other end.
	//
	// Note that messages can be sent only once because their
	// payload reader is drained.
	WriteMsg(Msg) error
}

type Peer

type Peer struct {
	// Peers have all the log methods.
	// Use them to display messages related to the peer.
	*logger.Logger
	// contains filtered or unexported fields
}

Peer represents a connected remote node.

func NewPeer

func NewPeer(id discover.NodeID, name string, caps []Cap) *Peer

NewPeer returns a peer for testing purposes.

func (*Peer) Caps

func (p *Peer) Caps() []Cap

Caps returns the capabilities (supported subprotocols) of the remote peer.

func (*Peer) Disconnect

func (p *Peer) Disconnect(reason DiscReason)

Disconnect terminates the peer connection with the given reason. It returns immediately and does not wait until the connection is closed.

func (*Peer) ID

func (p *Peer) ID() discover.NodeID

ID returns the node's public key.

func (*Peer) LocalAddr

func (p *Peer) LocalAddr() net.Addr

LocalAddr returns the local address of the network connection.

func (*Peer) Name

func (p *Peer) Name() string

Name returns the node name that the remote node advertised.

func (*Peer) RemoteAddr

func (p *Peer) RemoteAddr() net.Addr

RemoteAddr returns the remote address of the network connection.

func (*Peer) String

func (p *Peer) String() string

String implements fmt.Stringer.

type Protocol

type Protocol struct {
	// Name should contain the official protocol name,
	// often a three-letter word.
	Name string

	// Version should contain the version number of the protocol.
	Version uint

	// Length should contain the number of message codes used
	// by the protocol.
	Length uint64

	// Run is called in a new groutine when the protocol has been
	// negotiated with a peer. It should read and write messages from
	// rw. The Payload for each message must be fully consumed.
	//
	// The peer connection is closed when Start returns. It should return
	// any protocol-level error (such as an I/O error) that is
	// encountered.
	Run func(peer *Peer, rw MsgReadWriter) error
}

Protocol represents a P2P subprotocol implementation.

type Server

type Server struct {
	// This field must be set to a valid secp256k1 private key.
	PrivateKey *ecdsa.PrivateKey

	// MaxPeers is the maximum number of peers that can be
	// connected. It must be greater than zero.
	MaxPeers int

	// Name sets the node name of this server.
	// Use MakeName to create a name that follows existing conventions.
	Name string

	// Bootstrap nodes are used to establish connectivity
	// with the rest of the network.
	BootstrapNodes []*discover.Node

	// Protocols should contain the protocols supported
	// by the server. Matching protocols are launched for
	// each peer.
	Protocols []Protocol

	// If Blacklist is set to a non-nil value, the given Blacklist
	// is used to verify peer connections.
	Blacklist Blacklist

	// If ListenAddr is set to a non-nil address, the server
	// will listen for incoming connections.
	//
	// If the port is zero, the operating system will pick a port. The
	// ListenAddr field will be updated with the actual address when
	// the server is started.
	ListenAddr string

	// If set to a non-nil value, the given NAT port mapper
	// is used to make the listening port available to the
	// Internet.
	NAT nat.Interface

	// If Dialer is set to a non-nil value, the given Dialer
	// is used to dial outbound peer connections.
	Dialer *net.Dialer

	// If NoDial is true, the server will not dial any peers.
	NoDial bool
	// contains filtered or unexported fields
}

Server manages all peer connections.

The fields of Server are used as configuration parameters. You should set them before starting the Server. Fields may not be modified while the server is running.

func (*Server) Broadcast

func (srv *Server) Broadcast(protocol string, code uint64, data ...interface{})

Broadcast sends an RLP-encoded message to all connected peers. This method is deprecated and will be removed later.

func (*Server) PeerCount

func (srv *Server) PeerCount() int

PeerCount returns the number of connected peers.

func (*Server) Peers

func (srv *Server) Peers() (peers []*Peer)

Peers returns all connected peers.

func (*Server) Start

func (srv *Server) Start() (err error)

Start starts running the server. Servers can be re-used and started again after stopping.

func (*Server) Stop

func (srv *Server) Stop()

Stop terminates the server and all active peer connections. It blocks until all active connections have been closed.

func (*Server) SuggestPeer

func (srv *Server) SuggestPeer(n *discover.Node)

SuggestPeer creates a connection to the given Node if it is not already connected.