server

Documentation

Index

• Constants
• func IsPermissionError(err error) bool
• func ValidateRepoName(name string) error
• type APIServer
  • func NewAPIServer(address string, etcdAddresses []string, etcdPrefix string, cacheSize int64) (APIServer, error)
• type BlockAPIServer
  • func NewBlockAPIServer(dir string, cacheBytes int64, backend string, etcdAddress string) (BlockAPIServer, error)
• type CommitEvent
• type CommitStream
• type HTTPServer
  • func NewHTTPServer(address string, etcdAddresses []string, etcdPrefix string, cacheSize int64) (*HTTPServer, error)
• type ListFileMode

Constants

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

Valid object storage backends

const HTTPPort = 652

HTTPPort specifies the port the server will listen on

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, cacheSize int64) (APIServer, error)

NewAPIServer creates an APIServer. cacheSize is the number of commit trees which will be cached in the server.

type BlockAPIServer

type BlockAPIServer interface {
	pfsclient.ObjectAPIServer
}

BlockAPIServer combines BlockAPIServer and ObjectAPIServer.

func NewBlockAPIServer

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

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

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 HTTPServer

type HTTPServer struct {
	*httprouter.Router
	// contains filtered or unexported fields
}

HTTPServer serves GetFile requests over HTTP e.g. http://localhost:30652/v1/pfs/repos/foo/commits/b7a1923be56744f6a3f1525ec222dc3b/files/ttt.log

func NewHTTPServer

func NewHTTPServer(address string, etcdAddresses []string, etcdPrefix string, cacheSize int64) (*HTTPServer, error)

NewHTTPServer creates an APIServer. cacheSize is the number of commit trees which will be cached in the server.

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
)