nbd

README

nbd

Golang Linux Network Block Device as a local block device in user space.

Documentation

Overview

Package nbd uses the Linux NBD layer to emulate a block device in user space

Index

• Constants
• func FindDevice() (string, error)
• type Device
• type DeviceFinder
• type NBD
  • func Create(device Device, size int64, blocksize int64) *NBD
  • func (nbd *NBD) Close() error
  • func (nbd *NBD) Disconnect() error
  • func (nbd *NBD) IsConnected() bool
  • func (nbd *NBD) OpenDevice(dev string) (string, error)
  • func (nbd *NBD) Serve() error
  • func (nbd *NBD) SetBlockSize(blocksize int64) error
  • func (nbd *NBD) SetSize(size int64) error
  • func (nbd *NBD) Size() int64
• type NBDConn
  • func (c *NBDConn) Close() error
• type NBDServer
  • func NewNBDServer(addr string, finder DeviceFinder) (*NBDServer, error)
  • func (s *NBDServer) Close() error
  • func (s *NBDServer) Serve() error

Constants

const (
	// Defined in <linux/fs.h>:
	BLKROSET = 4701
)

Functions

func FindDevice

func FindDevice() (string, error)

Types

type Device

type Device interface {
	ReadAt(b []byte, off int64) (n int, err error)
	WriteAt(b []byte, off int64) (n int, err error)
	Sync() error
	Trim(off, len int64) error
	Size() uint64
	Close() error
}

Device interface is a subset of os.File.

type DeviceFinder

type DeviceFinder interface {
	FindDevice(name string) (Device, error)
	ListDevices() ([]string, error)
}

type NBD

type NBD struct {
	// contains filtered or unexported fields
}

func Create

func Create(device Device, size int64, blocksize int64) *NBD

func (*NBD) Close

func (nbd *NBD) Close() error

func (*NBD) Disconnect

func (nbd *NBD) Disconnect() error

func (*NBD) IsConnected

func (nbd *NBD) IsConnected() bool

return true if connected

func (*NBD) OpenDevice

func (nbd *NBD) OpenDevice(dev string) (string, error)

func (*NBD) Serve

func (nbd *NBD) Serve() error

func (*NBD) SetBlockSize

func (nbd *NBD) SetBlockSize(blocksize int64) error

func (*NBD) SetSize

func (nbd *NBD) SetSize(size int64) error

func (*NBD) Size

func (nbd *NBD) Size() int64

type NBDConn

type NBDConn struct {
	// contains filtered or unexported fields
}

func (*NBDConn) Close

func (c *NBDConn) Close() error

type NBDServer

type NBDServer struct {
	// contains filtered or unexported fields
}

func NewNBDServer

func NewNBDServer(addr string, finder DeviceFinder) (*NBDServer, error)

func (*NBDServer) Close

func (s *NBDServer) Close() error

func (*NBDServer) Serve

func (s *NBDServer) Serve() error