server

Documentation

Overview

Package server is a generated protocol buffer package.

It is generated from these files:

server/pfs/server/driver.proto

It has these top-level messages:

PutFileRecord
PutFileRecords

Index

• Constants
• func IsPermissionError(err error) bool
• func ValidateRepoName(name string) error
• type APIServer
  • func NewAPIServer(address string, etcdAddresses []string, etcdPrefix string, cacheBytes int64, ...) (APIServer, error)
• type BlockAPIServer
  • func NewBlockAPIServer(dir string, cacheBytes int64, backend string) (BlockAPIServer, error)
  • func NewLocalBlockAPIServer(dir string) (BlockAPIServer, error)
  • func NewObjBlockAPIServer(dir string, cacheBytes int64, objClient obj.Client) (BlockAPIServer, error)
• type CommitEvent
• type CommitStream
• type ListFileMode
• type PutFileRecord
  • func (*PutFileRecord) Descriptor() ([]byte, []int)
  • func (m *PutFileRecord) GetObjectHash() string
  • func (m *PutFileRecord) GetSizeBytes() int64
  • func (*PutFileRecord) ProtoMessage()
  • func (m *PutFileRecord) Reset()
  • func (m *PutFileRecord) String() string
• type PutFileRecords
  • func (*PutFileRecords) Descriptor() ([]byte, []int)
  • func (m *PutFileRecords) GetRecords() []*PutFileRecord
  • func (m *PutFileRecords) GetSplit() bool
  • func (*PutFileRecords) ProtoMessage()
  • func (m *PutFileRecords) Reset()
  • func (m *PutFileRecords) String() string

Constants

const (
	MinioBackendEnvVar     = "MINIO"
	AmazonBackendEnvVar    = "AMAZON"
	GoogleBackendEnvVar    = "GOOGLE"
	MicrosoftBackendEnvVar = "MICROSOFT"
)

Valid object storage backends

Functions

func IsPermissionError

func IsPermissionError(err error) bool

IsPermissionError returns true if a given error is a permission error.

func ValidateRepoName

func ValidateRepoName(name string) error

ValidateRepoName determines if a repo name is valid

Types

type APIServer

type APIServer interface {
	pfsclient.APIServer
}

APIServer represents and api server.

func NewAPIServer

func NewAPIServer(address string, etcdAddresses []string, etcdPrefix string, cacheBytes int64, reporter *metrics.Reporter) (APIServer, error)

NewAPIServer creates an APIServer.

type BlockAPIServer

type BlockAPIServer interface {
	pfsclient.ObjectAPIServer
}

BlockAPIServer combines BlockAPIServer and ObjectAPIServer.

func NewBlockAPIServer

func NewBlockAPIServer(dir string, cacheBytes int64, backend string) (BlockAPIServer, error)

NewBlockAPIServer creates a BlockAPIServer using the credentials it finds in the environment

func NewLocalBlockAPIServer

func NewLocalBlockAPIServer(dir string) (BlockAPIServer, error)

NewLocalBlockAPIServer creates a BlockAPIServer.

func NewObjBlockAPIServer

func NewObjBlockAPIServer(dir string, cacheBytes int64, objClient obj.Client) (BlockAPIServer, error)

NewObjBlockAPIServer create a BlockAPIServer from an obj.Client.

type CommitEvent

type CommitEvent struct {
	Err   error
	Value *pfs.CommitInfo
}

CommitEvent is an event that contains a CommitInfo or an error

type CommitStream

type CommitStream interface {
	Stream() <-chan CommitEvent
	Close()
}

CommitStream is a stream of CommitInfos

type ListFileMode

type ListFileMode int

ListFileMode specifies how ListFile executes.

const (
	// ListFileNORMAL computes sizes for files but not for directories
	ListFileNORMAL ListFileMode = iota
	// ListFileFAST does not compute sizes for files or directories
	ListFileFAST
	// ListFileRECURSE computes sizes for files and directories
	ListFileRECURSE
)

type PutFileRecord

type PutFileRecord struct {
	SizeBytes  int64  `protobuf:"varint,1,opt,name=size_bytes,json=sizeBytes,proto3" json:"size_bytes,omitempty"`
	ObjectHash string `protobuf:"bytes,2,opt,name=objectHash,proto3" json:"objectHash,omitempty"`
}

PutFileRecord is used to record PutFile requests in etcd temporarily.

func (*PutFileRecord) Descriptor

func (*PutFileRecord) Descriptor() ([]byte, []int)

func (*PutFileRecord) GetObjectHash

func (m *PutFileRecord) GetObjectHash() string

func (*PutFileRecord) GetSizeBytes

func (m *PutFileRecord) GetSizeBytes() int64

func (*PutFileRecord) ProtoMessage

func (*PutFileRecord) ProtoMessage()

func (*PutFileRecord) Reset

func (m *PutFileRecord) Reset()

func (*PutFileRecord) String

func (m *PutFileRecord) String() string

type PutFileRecords

type PutFileRecords struct {
	Split   bool             `protobuf:"varint,1,opt,name=split,proto3" json:"split,omitempty"`
	Records []*PutFileRecord `protobuf:"bytes,2,rep,name=records" json:"records,omitempty"`
}

func (*PutFileRecords) Descriptor

func (*PutFileRecords) Descriptor() ([]byte, []int)

func (*PutFileRecords) GetRecords

func (m *PutFileRecords) GetRecords() []*PutFileRecord

func (*PutFileRecords) GetSplit

func (m *PutFileRecords) GetSplit() bool

func (*PutFileRecords) ProtoMessage

func (*PutFileRecords) ProtoMessage()

func (*PutFileRecords) Reset

func (m *PutFileRecords) Reset()

func (*PutFileRecords) String

func (m *PutFileRecords) String() string