server

Documentation

Index

• Constants
• func GetPachClient(t testing.TB) *client.APIClient
• func IsPermissionError(err error) bool
• func RegisterCacheStats(cacheName string, groupCacheStats *groupcache.Stats)
• type APIServer
  • func NewAPIServer(address string, etcdAddresses []string, etcdPrefix string, ...) (APIServer, error)
• type BlockAPIServer
  • func NewBlockAPIServer(dir string, cacheBytes int64, backend string, etcdAddress string) (BlockAPIServer, error)
• type CommitEvent
• type CommitStream

Constants

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

Valid object storage backends

Functions

func GetPachClient

func GetPachClient(t testing.TB) *client.APIClient

GetPachClient initializes a new PFSAPIServer and blockAPIServer and begins serving requests for them on a new port, and then returns a client connected to the new servers (allows PFS tests to run in parallel without conflict)

func IsPermissionError

func IsPermissionError(err error) bool

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

func RegisterCacheStats

func RegisterCacheStats(cacheName string, groupCacheStats *groupcache.Stats)

RegisterCacheStats creates a new wrapper for groupcache stats that implements the prometheus.Collector interface, and registers it

Types

type APIServer

type APIServer interface {
	pfsclient.APIServer
}

APIServer represents and api server.

func NewAPIServer

func NewAPIServer(address string, etcdAddresses []string, etcdPrefix string, treeCache *hashtree.Cache, storageRoot string, memoryRequest int64) (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, 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