cas

Documentation

Overview

Package cas contains implementation of cipd.Storage service RPC service.

There are two instances of the implementation available:

• The internal one, that doesn't do any ACL checks and that can be used internally by the CIPD backend. Get it with Internal().
• The publicly exposed one. It wraps the internal one, adding ACLs. Get it with Public().

Index

• func Public(internal api.StorageServer) api.StorageServer
• type StorageServer
  • func Internal(d *tq.Dispatcher, b *bqlog.Bundler, s *settings.Settings, opts *server.Options) StorageServer

Functions

func Public

func Public(internal api.StorageServer) api.StorageServer

Public returns publicly exposed implementation of cipd.Storage service that wraps the given internal implementation with ACLs.

Types

type StorageServer

type StorageServer interface {
	api.StorageServer

	// GetReader returns an io.ReaderAt implementation to read contents of an
	// object in the storage.
	//
	// Returns grpc errors. In particular NotFound is returned if there's no such
	// object in the storage.
	GetReader(ctx context.Context, ref *api.ObjectRef) (gs.Reader, error)
}

StorageServer extends StorageServer RPC interface with some methods used internally by other CIPD server modules.

func Internal

func Internal(d *tq.Dispatcher, b *bqlog.Bundler, s *settings.Settings, opts *server.Options) StorageServer

Internal returns non-ACLed implementation of StorageService.

It can be used internally by the backend. Assumes ACL checks are already done.

Registers some task queue tasks in the given dispatcher and log sinks in the given bundler.