Documentation ¶
Overview ¶
Copyright 2015 The etcd Authors Modified work copyright 2018 The tiglabs Authors.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Index ¶
- type MemoryStorage
- func (ms *MemoryStorage) ApplySnapshot(meta proto.SnapshotMeta) error
- func (ms *MemoryStorage) Close()
- func (ms *MemoryStorage) Entries(lo, hi uint64, maxSize uint64) (entries []*proto.Entry, isCompact bool, err error)
- func (ms *MemoryStorage) FirstIndex() (uint64, error)
- func (ms *MemoryStorage) InitialState() (proto.HardState, error)
- func (ms *MemoryStorage) LastIndex() (uint64, error)
- func (ms *MemoryStorage) StoreEntries(entries []*proto.Entry) error
- func (ms *MemoryStorage) StoreHardState(st proto.HardState) error
- func (ms *MemoryStorage) Term(index uint64) (term uint64, isCompact bool, err error)
- func (ms *MemoryStorage) Truncate(index uint64) error
- type Storage
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type MemoryStorage ¶
type MemoryStorage struct {
// contains filtered or unexported fields
}
This storage is circular storage in memory and truncate when over capacity, but keep it a high capacity.
func DefaultMemoryStorage ¶
func DefaultMemoryStorage() *MemoryStorage
func NewMemoryStorage ¶
func NewMemoryStorage(fsm fsm, id, capacity uint64) *MemoryStorage
func (*MemoryStorage) ApplySnapshot ¶
func (ms *MemoryStorage) ApplySnapshot(meta proto.SnapshotMeta) error
func (*MemoryStorage) Close ¶
func (ms *MemoryStorage) Close()
func (*MemoryStorage) FirstIndex ¶
func (ms *MemoryStorage) FirstIndex() (uint64, error)
func (*MemoryStorage) InitialState ¶
func (ms *MemoryStorage) InitialState() (proto.HardState, error)
func (*MemoryStorage) LastIndex ¶
func (ms *MemoryStorage) LastIndex() (uint64, error)
func (*MemoryStorage) StoreEntries ¶
func (ms *MemoryStorage) StoreEntries(entries []*proto.Entry) error
func (*MemoryStorage) StoreHardState ¶
func (ms *MemoryStorage) StoreHardState(st proto.HardState) error
func (*MemoryStorage) Term ¶
func (ms *MemoryStorage) Term(index uint64) (term uint64, isCompact bool, err error)
func (*MemoryStorage) Truncate ¶
func (ms *MemoryStorage) Truncate(index uint64) error
type Storage ¶
type Storage interface { // InitialState returns the saved HardState information to init the repl state. InitialState() (proto.HardState, error) // Entries returns a slice of log entries in the range [lo,hi), the hi is not inclusive. // MaxSize limits the total size of the log entries returned, but Entries returns at least one entry if any. // If lo <= CompactIndex,then return isCompact true. // If no entries,then return entries nil. // Note: math.MaxUint32 is no limit. Entries(lo, hi uint64, maxSize uint64) (entries []*proto.Entry, isCompact bool, err error) // Term returns the term of entry i, which must be in the range [FirstIndex()-1, LastIndex()]. // The term of the entry before FirstIndex is retained for matching purposes even though the // rest of that entry may not be available. // If lo <= CompactIndex,then return isCompact true. Term(i uint64) (term uint64, isCompact bool, err error) // FirstIndex returns the index of the first log entry that is possibly available via Entries (older entries have been incorporated // into the latest Snapshot; if storage only contains the dummy entry the first log entry is not available). FirstIndex() (uint64, error) // LastIndex returns the index of the last entry in the log. LastIndex() (uint64, error) // StoreEntries store the log entries to the repository. // If first index of entries > LastIndex,then append all entries, // Else write entries at first index and truncate the redundant log entries. StoreEntries(entries []*proto.Entry) error // StoreHardState store the raft state to the repository. StoreHardState(st proto.HardState) error // Truncate the log to index, The index is inclusive. Truncate(index uint64) error // Sync snapshot status. ApplySnapshot(meta proto.SnapshotMeta) error // Close the storage. Close() }
Storage is an interface that may be implemented by the application to retrieve log entries from storage. If any Storage method returns an error, the raft instance will become inoperable and refuse to participate in elections; the application is responsible for cleanup and recovery in this case.