pkg/SugarDB
1
0
Fork 0
mirror of https://github.com/EchoVault/SugarDB.git synced 2025-10-05 07:56:52 +08:00
Code Issues Packages Projects Releases Wiki Activity

Added godoc comments for echovault.go exported functions

Browse Source
This commit is contained in:
Kelvin Mwinuka
2024-04-04 03:18:56 +08:00
parent 169fa39204
commit e42582ef66
3 changed files with 610 additions and 609 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1212
coverage/coverage.out
View File

File diff suppressed because it is too large Load Diff

4
pkg/echovault/echovault.go
View File

@@ -474,6 +474,7 @@ func (server *EchoVault) setLatestSnapshot(msec int64) {
server.latestSnapshotMilliseconds.Store(msec) server.latestSnapshotMilliseconds.Store(msec)
} }
// GetLatestSnapshotTime returns the latest snapshot time in unix epoch milliseconds.
func (server *EchoVault) GetLatestSnapshotTime() int64 { func (server *EchoVault) GetLatestSnapshotTime() int64 {
return server.latestSnapshotMilliseconds.Load() return server.latestSnapshotMilliseconds.Load()
} }
@@ -486,6 +487,7 @@ func (server *EchoVault) finishRewriteAOF() {
server.rewriteAOFInProgress.Store(false) server.rewriteAOFInProgress.Store(false)
} }
// RewriteAOF triggers an AOF compaction when running in standalone mode.
func (server *EchoVault) RewriteAOF() error { func (server *EchoVault) RewriteAOF() error {
if server.rewriteAOFInProgress.Load() { if server.rewriteAOFInProgress.Load() {
return errors.New("aof rewrite in progress") return errors.New("aof rewrite in progress")
@@ -498,6 +500,8 @@ func (server *EchoVault) RewriteAOF() error {
return nil return nil
} }
// ShutDown gracefully shuts down the EchoVault instance.
// This function shuts down the memberlist and raft layers.
func (server *EchoVault) ShutDown() { func (server *EchoVault) ShutDown() {
if server.isInCluster() { if server.isInCluster() {
server.raft.RaftShutdown() server.raft.RaftShutdown()

3
pkg/types/types.go
View File

@@ -39,9 +39,6 @@ type EchoVault interface {
TakeSnapshot() error TakeSnapshot() error
RewriteAOF() error RewriteAOF() error
GetLatestSnapshotTime() int64 GetLatestSnapshotTime() int64
//StartSnapshot()
//FinishSnapshot()
//SetLatestSnapshot(msec int64)
} }
type KeyExtractionFunc func(cmd []string) ([]string, error) type KeyExtractionFunc func(cmd []string) ([]string, error)