vbatts/go-nbdkit
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Import nbdkit-1.20.2

Browse source
This commit is contained in:
Matthew Arnold 2020-09-28 20:00:39 +00:00
parent 695421107b
commit 2698e06713
1 changed files with 20 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
nbdkit.go
View file

@ -103,42 +103,44 @@ const (
// The plugin interface. // The plugin interface.
type PluginInterface interface { type PluginInterface interface {
// Open is required for all plugins.
// Other methods are optional.
Load() Load()
Unload() Unload()
DumpPlugin() DumpPlugin()
Config(key string, value string) error Config(key string, value string) error
ConfigComplete() error ConfigComplete() error
GetReady() error GetReady() error
PreConnect(readonly bool) error PreConnect(readonly bool) error
Open(readonly bool) (ConnectionInterface, error) Open(readonly bool) (ConnectionInterface, error) // required
} }
// The client connection interface. // The client connection interface.
type ConnectionInterface interface { type ConnectionInterface interface {
// GetSize and PRead are required for all plugins. GetSize() (uint64, error) // required
// Other methods are optional.
Close()
GetSize() (uint64, error)
CanWrite() (bool, error)
CanFlush() (bool, error)
IsRotational() (bool, error) IsRotational() (bool, error)
CanTrim() (bool, error)
CanZero() (bool, error)
CanMultiConn() (bool, error) CanMultiConn() (bool, error)
PRead(buf []byte, offset uint64, flags uint32) error PRead(buf []byte, offset uint64, flags uint32) error // required
// NB: This will NOT be called unless CanWrite returns true.
// NB: PWrite will NOT be called unless CanWrite returns true.
CanWrite() (bool, error)
PWrite(buf []byte, offset uint64, flags uint32) error PWrite(buf []byte, offset uint64, flags uint32) error
// NB: This will NOT be called unless CanFlush returns true.
// NB: Flush will NOT be called unless CanFlush returns true.
CanFlush() (bool, error)
Flush(flags uint32) error Flush(flags uint32) error
// NB: This will NOT be called unless CanTrim returns true.
// NB: Trim will NOT be called unless CanTrim returns true.
CanTrim() (bool, error)
Trim(count uint32, offset uint64, flags uint32) error Trim(count uint32, offset uint64, flags uint32) error
// NB: This will NOT be called unless CanZero returns true.
// NB: Zero will NOT be called unless CanZero returns true.
CanZero() (bool, error)
Zero(count uint32, offset uint64, flags uint32) error Zero(count uint32, offset uint64, flags uint32) error
Close()
} }
// Default implementations for plugin interface methods. // Default implementations for plugin interface methods.