interesting
/
go-ethereum
mirror of https://github.com/ethereum/go-ethereum.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

eth/downloader: Doc fixes

This commit is contained in:
Nick Johnson 2017-07-05 10:42:37 +01:00
parent be8f8409bc
commit fe13949d9d
2 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
eth/downloader/downloader.go
View File

@ -153,6 +153,7 @@ type Downloader struct {
chainInsertHook func([]*fetchResult) // Method to call upon inserting a chain of blocks (possibly in multiple invocations) chainInsertHook func([]*fetchResult) // Method to call upon inserting a chain of blocks (possibly in multiple invocations)
} }
// LightChain encapsulates functions required to synchronise a light chain.
type LightChain interface { type LightChain interface {
// HasHeader verifies a header's presence in the local chain. // HasHeader verifies a header's presence in the local chain.
HasHeader(common.Hash) bool HasHeader(common.Hash) bool
@ -173,6 +174,7 @@ type LightChain interface {
Rollback([]common.Hash) Rollback([]common.Hash)
} }
// BlockChain encapsulates functions required to sync a (full or fast) blockchain.
type BlockChain interface { type BlockChain interface {
LightChain LightChain
@ -281,7 +283,7 @@ func (d *Downloader) RegisterPeer(id string, version int, peer Peer) error {
return nil return nil
} }
// RegisterLightPeer injects a light client peer // RegisterLightPeer injects a light client peer, wrapping it so it appears as a regular peer.
func (d *Downloader) RegisterLightPeer(id string, version int, peer LightPeer) error { func (d *Downloader) RegisterLightPeer(id string, version int, peer LightPeer) error {
return d.RegisterPeer(id, version, &lightPeerWrapper{peer}) return d.RegisterPeer(id, version, &lightPeerWrapper{peer})
} }

6
eth/downloader/peer.go
View File

@ -45,7 +45,7 @@ var (
errNotRegistered = errors.New("peer is not registered") errNotRegistered = errors.New("peer is not registered")
) )
// peer represents an active peer from which hashes and blocks are retrieved. // peerConnection represents an active peer from which hashes and blocks are retrieved.
type peerConnection struct { type peerConnection struct {
id string // Unique identifier of the peer id string // Unique identifier of the peer
@ -75,12 +75,14 @@ type peerConnection struct {
lock sync.RWMutex lock sync.RWMutex
} }
// LightPeer encapsulates the methods required to synchronise with a remote light peer.
type LightPeer interface { type LightPeer interface {
Head() (common.Hash, *big.Int) Head() (common.Hash, *big.Int)
RequestHeadersByHash(common.Hash, int, int, bool) error RequestHeadersByHash(common.Hash, int, int, bool) error
RequestHeadersByNumber(uint64, int, int, bool) error RequestHeadersByNumber(uint64, int, int, bool) error
} }
// Peer encapsulates the methods required to synchronise with a remote full peer.
type Peer interface { type Peer interface {
LightPeer LightPeer
RequestBodies([]common.Hash) error RequestBodies([]common.Hash) error
@ -110,7 +112,7 @@ func (w *lightPeerWrapper) RequestNodeData([]common.Hash) error {
panic("RequestNodeData not supported in light client mode sync") panic("RequestNodeData not supported in light client mode sync")
} }
// newPeerConnection creates a new downloader peer // newPeerConnection creates a new downloader peer.
func newPeerConnection(id string, version int, peer Peer, logger log.Logger) *peerConnection { func newPeerConnection(id string, version int, peer Peer, logger log.Logger) *peerConnection {
return &peerConnection{ return &peerConnection{
id: id, id: id,