github.com/ConsenSys/Quorum@v20.10.0+incompatible/eth/downloader/modes.go (about) 1 // Copyright 2015 The go-ethereum Authors 2 // This file is part of the go-ethereum library. 3 // 4 // The go-ethereum library is free software: you can redistribute it and/or modify 5 // it under the terms of the GNU Lesser General Public License as published by 6 // the Free Software Foundation, either version 3 of the License, or 7 // (at your option) any later version. 8 // 9 // The go-ethereum library is distributed in the hope that it will be useful, 10 // but WITHOUT ANY WARRANTY; without even the implied warranty of 11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 // GNU Lesser General Public License for more details. 13 // 14 // You should have received a copy of the GNU Lesser General Public License 15 // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>. 16 17 package downloader 18 19 import "fmt" 20 21 // SyncMode represents the synchronisation mode of the downloader. 22 type SyncMode int 23 24 const ( 25 FullSync SyncMode = iota // Synchronise the entire blockchain history from full blocks 26 FastSync // Quickly download the headers, full sync only at the chain head 27 LightSync // Download only the headers and terminate afterwards 28 // Used by raft: 29 BoundedFullSync SyncMode = 100 // Perform a full sync until the requested hash, and no further 30 ) 31 32 func (mode SyncMode) IsValid() bool { 33 return mode >= FullSync && mode <= LightSync 34 } 35 36 // String implements the stringer interface. 37 func (mode SyncMode) String() string { 38 switch mode { 39 case FullSync: 40 return "full" 41 case FastSync: 42 return "fast" 43 case LightSync: 44 return "light" 45 default: 46 return "unknown" 47 } 48 } 49 50 func (mode SyncMode) MarshalText() ([]byte, error) { 51 switch mode { 52 case FullSync: 53 return []byte("full"), nil 54 case FastSync: 55 return []byte("fast"), nil 56 case LightSync: 57 return []byte("light"), nil 58 default: 59 return nil, fmt.Errorf("unknown sync mode %d", mode) 60 } 61 } 62 63 func (mode *SyncMode) UnmarshalText(text []byte) error { 64 switch string(text) { 65 case "full": 66 *mode = FullSync 67 case "fast": 68 *mode = FastSync 69 case "light": 70 *mode = LightSync 71 default: 72 return fmt.Errorf(`unknown sync mode %q, want "full", "fast" or "light"`, text) 73 } 74 return nil 75 }