kayos/bitraft
1
0
Fork 0
mirror of https://git.mills.io/kayos/bitraft.git synced 2024-06-28 09:41:38 +00:00
Code Issues Projects Releases Wiki Activity

Improve documentation, omit unused parameters

Browse Source
This commit is contained in:
kayos@tcp.direct 2022-02-28 02:04:06 -08:00
parent bb3049b946
commit 72936c494e
Signed by: kayos
GPG Key ID: 4B841471B4BEE979
1 changed files with 17 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
server.go
View File

@ -80,7 +80,7 @@ func ListenAndServe(addr, join, dir, logdir string, consistency, durability finn
return true return true
}, },
} }
m, err := NewMachine(dir, addr) m, err := NewMachine(dir)
if err != nil { if err != nil {
return err return err
} }
@ -103,15 +103,16 @@ type Machine struct {
dir string dir string
db *bitcask.Bitcask db *bitcask.Bitcask
dbPath string dbPath string
addr string // TODO: what was "addr" for?
// addr string
closed bool closed bool
cmdMapper map[string]cmdHandler cmdMapper map[string]cmdHandler
} }
func NewMachine(dir, addr string) (*Machine, error) { func NewMachine(dir string) (*Machine, error) {
kvm := &Machine{ kvm := &Machine{
dir: dir, dir: dir,
addr: addr, // addr: addr,
} }
kvm.cmdMapper = map[string]cmdHandler{ kvm.cmdMapper = map[string]cmdHandler{
"echo": kvm.cmdEcho, "set": kvm.cmdSet, "echo": kvm.cmdEcho, "set": kvm.cmdSet,
@ -127,12 +128,13 @@ func NewMachine(dir, addr string) (*Machine, error) {
return kvm, nil return kvm, nil
} }
func (kvm *Machine) Close() error { // Close shuts down our finite state machine and presumably, our database.
func (kvm *Machine) Close() (err error) {
kvm.mu.Lock() kvm.mu.Lock()
defer kvm.mu.Unlock() defer kvm.mu.Unlock()
kvm.db.Close() err = kvm.db.Close()
kvm.closed = true kvm.closed = true
return nil return
} }
func (kvm *Machine) Command(m finn.Applier, conn redcon.Conn, cmd redcon.Command) (interface{}, error) { func (kvm *Machine) Command(m finn.Applier, conn redcon.Conn, cmd redcon.Command) (interface{}, error) {
@ -160,6 +162,8 @@ func (kvm *Machine) Command(m finn.Applier, conn redcon.Conn, cmd redcon.Command
} }
} }
// Restore attempts to restore a database from rd, which implements an io.Reader.
// This is meant to restore data exported by the Snapshot function.
func (kvm *Machine) Restore(rd io.Reader) error { func (kvm *Machine) Restore(rd io.Reader) error {
kvm.mu.Lock() kvm.mu.Lock()
defer kvm.mu.Unlock() defer kvm.mu.Unlock()
@ -270,6 +274,7 @@ func WriteRedisCommandsFromSnapshot(wr io.Writer, snapshotPath string) error {
return err return err
} }
// Snapshot writes a snapshot of the database to wr, which implements io.Writer.
func (kvm *Machine) Snapshot(wr io.Writer) error { func (kvm *Machine) Snapshot(wr io.Writer) error {
kvm.mu.RLock() kvm.mu.RLock()
defer kvm.mu.RUnlock() defer kvm.mu.RUnlock()