comm

Documentation

Index

• type Communicator
  • func NewCommunicator(ctx context.Context, chain *chain.Chain, txPool *txpool.TxPool, magic [4]byte, ...) *Communicator
  • func (c *Communicator) BroadcastBlock(blk *block.EscortedBlock)
  • func (c *Communicator) GetPeers() []*p2p.Peer
  • func (c *Communicator) PeerCount() int
  • func (c *Communicator) PeersStats() []*PeerStats
  • func (c *Communicator) Start()
  • func (c *Communicator) Stop()
  • func (c *Communicator) SubscribeBlock(ch chan *NewBlockEvent) event.Subscription
  • func (c *Communicator) Sync(handler HandleBlockStream)
  • func (c *Communicator) SyncedCh() <-chan struct{}
• type DirectionCount
• type HandleBlockStream
• type HandleQC
• type NewBlockEvent
• type Peer
  • func (p *Peer) Debug(msg string, ctx ...interface{})
  • func (p *Peer) Duration() mclock.AbsTime
  • func (p *Peer) Error(msg string, ctx ...interface{})
  • func (p *Peer) Head() (id types.Bytes32, number uint32)
  • func (p *Peer) Info(msg string, ctx ...interface{})
  • func (p *Peer) IsBlockKnown(id types.Bytes32) bool
  • func (p *Peer) IsTransactionKnown(id []byte) bool
  • func (p *Peer) MarkBlock(id types.Bytes32)
  • func (p *Peer) MarkTransaction(id []byte)
  • func (p *Peer) String() string
  • func (p *Peer) UpdateHead(id types.Bytes32, number uint32)
  • func (p *Peer) Warn(msg string, ctx ...interface{})
• type PeerSet
  • func (ps *PeerSet) Add(peer *Peer, dir string)
  • func (ps *PeerSet) DirectionCount() DirectionCount
  • func (ps *PeerSet) Find(nodeID enode.ID) *Peer
  • func (ps *PeerSet) Len() int
  • func (ps *PeerSet) Remove(nodeID enode.ID) *Peer
  • func (ps *PeerSet) Slice() Peers
• type PeerStats
• type Peers
  • func (ps Peers) Filter(cond func(*Peer) bool) Peers
  • func (ps Peers) Find(cond func(*Peer) bool) *Peer

Types

type Communicator

type Communicator struct {
	Synced bool
	// contains filtered or unexported fields
}

Communicator communicates with remote p2p peers to exchange blocks and txs, etc.

func NewCommunicator

func NewCommunicator(ctx context.Context, chain *chain.Chain, txPool *txpool.TxPool, magic [4]byte, p2pConfig p2p.Config, rootDir string) *Communicator

New create a new Communicator instance.

func (*Communicator) BroadcastBlock

func (c *Communicator) BroadcastBlock(blk *block.EscortedBlock)

BroadcastBlock broadcast a block to remote peers.

func (*Communicator) GetPeers

func (c *Communicator) GetPeers() []*p2p.Peer

func (*Communicator) PeerCount

func (c *Communicator) PeerCount() int

PeerCount returns count of peers.

func (*Communicator) PeersStats

func (c *Communicator) PeersStats() []*PeerStats

PeersStats returns all peers' stats

func (*Communicator) Start

func (c *Communicator) Start()

Start the communicator.

func (*Communicator) Stop

func (c *Communicator) Stop()

Stop stop the communicator.

func (*Communicator) SubscribeBlock

func (c *Communicator) SubscribeBlock(ch chan *NewBlockEvent) event.Subscription

SubscribeBlock subscribe the event that new block received.

func (*Communicator) Sync

func (c *Communicator) Sync(handler HandleBlockStream)

Sync start synchronization process.

func (*Communicator) SyncedCh

func (c *Communicator) SyncedCh() <-chan struct{}

Synced returns a channel indicates if synchronization process passed.

type DirectionCount

type DirectionCount struct {
	Inbound  int
	Outbound int
}

type HandleBlockStream

type HandleBlockStream func(ctx context.Context, stream <-chan *block.EscortedBlock) error

HandleBlockStream to handle the stream of downloaded blocks in sync process.

type HandleQC

type HandleQC func(ctx context.Context, qc *block.QuorumCert) (bool, error)

type NewBlockEvent

type NewBlockEvent struct {
	*block.EscortedBlock
}

NewBlockEvent event emitted when received block announcement.

type Peer

type Peer struct {
	*p2p.Peer
	*rpc.RPC
	// contains filtered or unexported fields
}

Peer extends p2p.Peer with RPC integrated.

func (*Peer) Debug

func (p *Peer) Debug(msg string, ctx ...interface{})

func (*Peer) Duration

func (p *Peer) Duration() mclock.AbsTime

Duration returns duration of connection.

func (*Peer) Error

func (p *Peer) Error(msg string, ctx ...interface{})

func (*Peer) Head

func (p *Peer) Head() (id types.Bytes32, number uint32)

Head returns head block ID and total score.

func (*Peer) Info

func (p *Peer) Info(msg string, ctx ...interface{})

func (*Peer) IsBlockKnown

func (p *Peer) IsBlockKnown(id types.Bytes32) bool

IsBlockKnown returns if the block is known.

func (*Peer) IsTransactionKnown

func (p *Peer) IsTransactionKnown(id []byte) bool

IsTransactionKnown returns if the transaction is known.

func (*Peer) MarkBlock

func (p *Peer) MarkBlock(id types.Bytes32)

MarkBlock marks a block to known.

func (*Peer) MarkTransaction

func (p *Peer) MarkTransaction(id []byte)

MarkTransaction marks a transaction to known.

func (*Peer) String

func (p *Peer) String() string

func (*Peer) UpdateHead

func (p *Peer) UpdateHead(id types.Bytes32, number uint32)

UpdateHead update ID and total score of head block.

func (*Peer) Warn

func (p *Peer) Warn(msg string, ctx ...interface{})

type PeerSet

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

PeerSet manages a set of peers, which mapped by NodeID.

func (*PeerSet) Add

func (ps *PeerSet) Add(peer *Peer, dir string)

Add add a new peer.

func (*PeerSet) DirectionCount

func (ps *PeerSet) DirectionCount() DirectionCount

func (*PeerSet) Find

func (ps *PeerSet) Find(nodeID enode.ID) *Peer

Find find peer for given nodeID.

func (*PeerSet) Len

func (ps *PeerSet) Len() int

Len returns length of set.

func (*PeerSet) Remove

func (ps *PeerSet) Remove(nodeID enode.ID) *Peer

Remove removes peer for given nodeID.

func (*PeerSet) Slice

func (ps *PeerSet) Slice() Peers

Slice dumps all peers into a slice. The dumped slice is a random permutation.

type PeerStats

type PeerStats struct {
	Name         string
	BestBlockID  types.Bytes32
	BestBlockNum uint32
	PeerID       string
	NetAddr      string
	Inbound      bool
	Duration     uint64 // in seconds
}

PeerStats records stats of a peer.

type Peers

type Peers []*Peer

Peers slice of peers

func (Peers) Filter

func (ps Peers) Filter(cond func(*Peer) bool) Peers

Filter filter out sub set of peers that satisfies the given condition.

func (Peers) Find

func (ps Peers) Find(cond func(*Peer) bool) *Peer

Find find one peer that satisfies the given condition.