sub

Documentation

Index

• Constants
• func VerifyDisruptionState(state DisruptionState) bool
• type BoostCpuLimitRequest
• type BoostCpuLimitResponse
• type BoostScanLimitRequest
• type BoostScanLimitResponse
• type CleanupRequest
• type CleanupResponse
• type Configuration
  • func (configuration Configuration) String() string
• type DisruptionRequest
  • func (disruptionRequest *DisruptionRequest) CheckValid() error
  • func (disruptionRequest DisruptionRequest) MarshalText() ([]byte, error)
  • func (disruptionRequest *DisruptionRequest) Set(value string) error
  • func (disruptionRequest DisruptionRequest) String() string
  • func (disruptionRequest *DisruptionRequest) UnmarshalText(text []byte) error
• type DisruptionState
  • func (state DisruptionState) MarshalText() (text []byte, err error)
  • func (state DisruptionState) String() string
  • func (state *DisruptionState) UnmarshalText(text []byte) error
• type FetchRequest
• type FetchResponse
• type FileToCopyToCache
• type GetConfigurationRequest
• type GetConfigurationResponse
  • func (configuration GetConfigurationResponse) String() string
• type GetFileResponse
• type Hardlink
• type Inode
• type PollRequest
• type PollResponse
• type SetConfigurationRequest
• type SetConfigurationResponse
• type UpdateRequest
• type UpdateResponse

Constants

const (
	DisruptionRequestCheck   = DisruptionRequest(0)
	DisruptionRequestRequest = DisruptionRequest(1)
	DisruptionRequestCancel  = DisruptionRequest(2)

	DisruptionStateAnytime   = DisruptionState(0) // Not implemented/configured.
	DisruptionStatePermitted = DisruptionState(1)
	DisruptionStateRequested = DisruptionState(2)
	DisruptionStateDenied    = DisruptionState(3)

	ErrorDisruptionPending = "disruption pending"
	ErrorDisruptionDenied  = "disruption denied"
)

Functions

func VerifyDisruptionState

func VerifyDisruptionState(state DisruptionState) bool

Types

type BoostCpuLimitRequest

type BoostCpuLimitRequest struct{}

type BoostCpuLimitResponse

type BoostCpuLimitResponse struct{}

type BoostScanLimitRequest

type BoostScanLimitRequest struct{}

type BoostScanLimitResponse

type BoostScanLimitResponse struct{}

type CleanupRequest

type CleanupRequest struct {
	Hashes []hash.Hash
}

type CleanupResponse

type CleanupResponse struct{}

type Configuration

type Configuration struct {
	CpuPercent          uint
	OwnerGroups         []string
	OwnerUsers          []string
	NetworkSpeedPercent uint
	ScanSpeedPercent    uint
	ScanExclusionList   []string
}

func (Configuration) String

func (configuration Configuration) String() string

type DisruptionRequest

type DisruptionRequest uint

func (*DisruptionRequest) CheckValid

func (disruptionRequest *DisruptionRequest) CheckValid() error

func (DisruptionRequest) MarshalText

func (disruptionRequest DisruptionRequest) MarshalText() ([]byte, error)

func (*DisruptionRequest) Set

func (disruptionRequest *DisruptionRequest) Set(value string) error

func (DisruptionRequest) String

func (disruptionRequest DisruptionRequest) String() string

func (*DisruptionRequest) UnmarshalText

func (disruptionRequest *DisruptionRequest) UnmarshalText(text []byte) error

type DisruptionState

type DisruptionState uint

func (DisruptionState) MarshalText

func (state DisruptionState) MarshalText() (text []byte, err error)

func (DisruptionState) String

func (state DisruptionState) String() string

func (*DisruptionState) UnmarshalText

func (state *DisruptionState) UnmarshalText(text []byte) error

type FetchRequest

type FetchRequest struct {
	LockFor       time.Duration // Duration to lock other clients from mutating.
	ServerAddress string
	SpeedPercent  byte
	Wait          bool
	Hashes        []hash.Hash
}

type FetchResponse

type FetchResponse struct {
	LockedUntil time.Time
}

type FileToCopyToCache

type FileToCopyToCache struct {
	Name       string
	Hash       hash.Hash
	DoHardlink bool
}

type GetConfigurationRequest

type GetConfigurationRequest struct{}

type GetConfigurationResponse

type GetConfigurationResponse Configuration

func (GetConfigurationResponse) String

func (configuration GetConfigurationResponse) String() string

type GetFileResponse

type GetFileResponse struct {
	Error string
	Size  uint64

} // File data are streamed afterwards.

type Hardlink

type Hardlink struct {
	NewLink string
	Target  string
}

type Inode

type Inode struct {
	Name string
	filesystem.GenericInode
}

type PollRequest

type PollRequest struct {
	HaveGeneration uint64
	LockFor        time.Duration
	ShortPollOnly  bool // If true, do not send FileSystem or ObjectCache.
}

type PollResponse

type PollResponse struct {
	NetworkSpeed                 uint64 // Capacity of the network interface.
	CurrentConfiguration         Configuration
	FetchInProgress              bool // Fetch() and Update() mutually exclusive
	UpdateInProgress             bool
	InitialImageName             string
	LastFetchError               string
	LastNote                     string // Updated after successful Update().
	LastSuccessfulImageName      string
	LastUpdateError              string
	LastUpdateHadTriggerFailures bool
	LastWriteError               string
	LockedByAnotherClient        bool // Fetch() and Update() restricted.
	LockedUntil                  time.Time
	FreeSpace                    *uint64
	StartTime                    time.Time
	PollTime                     time.Time
	ScanCount                    uint64
	DurationOfLastScan           time.Duration
	GenerationCount              uint64
	SystemUptime                 *time.Duration
	DisruptionState              DisruptionState
	FileSystemFollows            bool
	FileSystem                   *filesystem.FileSystem  // Streamed separately.
	ObjectCache                  objectcache.ObjectCache // Streamed separately.

} // FileSystem is encoded afterwards, followed by ObjectCache.

type SetConfigurationRequest

type SetConfigurationRequest Configuration

type SetConfigurationResponse

type SetConfigurationResponse struct{}

type UpdateRequest

type UpdateRequest struct {
	ForceDisruption bool
	ImageName       string
	Wait            bool
	// The ordering here reflects the ordering that the sub is expected to use.
	FilesToCopyToCache  []FileToCopyToCache
	DirectoriesToMake   []Inode
	InodesToMake        []Inode
	HardlinksToMake     []Hardlink
	PathsToDelete       []string
	InodesToChange      []Inode
	MultiplyUsedObjects map[hash.Hash]uint64
	Triggers            *triggers.Triggers
}

type UpdateResponse

type UpdateResponse struct{}