reflector

Documentation

Index

• Constants
• Variables
• func BlobHash(blob []byte) string
• func IsValidJSON(b []byte) bool
• type Client
  • func (c *Client) Close() error
  • func (c *Client) Connect(address string) error
  • func (c *Client) SendBlob(blob stream.Blob) error
• type Server
  • func NewServer(store store.BlobStore) *Server
  • func (s *Server) Shutdown()
  • func (s *Server) Start(address string) error
• type Summary
• type Uploader
  • func NewUploader(db *db.SQL, store *store.DBBackedStore, workers int, skipExistsCheck bool) *Uploader
  • func (u *Uploader) GetSummary() Summary
  • func (u *Uploader) Stop()
  • func (u *Uploader) Upload(dirOrFilePath string) error

Constants

const (
	// DefaultPort is the port the reflector server listens on if not passed in.
	DefaultPort = 5566
	// DefaultTimeout is the default timeout to read or write the next message
	DefaultTimeout = 5 * time.Second
)

Variables

var ErrBlobExists = errors.Base("blob exists on server")

ErrBlobExists is a default error for when a blob already exists on the reflector server.

var ErrBlobTooBig = errors.Base("blob must be at most %d bytes", maxBlobSize)

Functions

func BlobHash

func BlobHash(blob []byte) string

BlobHash returns the sha512 hash hex encoded string of the blob byte slice.

func IsValidJSON

func IsValidJSON(b []byte) bool

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is an instance of a client connected to a server.

func (*Client) Close

func (c *Client) Close() error

Close closes the connection with the client.

func (*Client) Connect

func (c *Client) Connect(address string) error

Connect connects to a specific clients and errors if it cannot be contacted.

func (*Client) SendBlob

func (c *Client) SendBlob(blob stream.Blob) error

SendBlob sends a send blob request to the client.

type Server

type Server struct {
	Timeout time.Duration // timeout to read or write next message

	EnableBlocklist bool // if true, blocklist checking and blob deletion will be enabled
	// contains filtered or unexported fields
}

Server is and instance of the reflector server. It houses the blob store and listener.

func NewServer

func NewServer(store store.BlobStore) *Server

NewServer returns an initialized reflector server pointer.

func (*Server) Shutdown

func (s *Server) Shutdown()

Shutdown shuts down the reflector server gracefully.

func (*Server) Start

func (s *Server) Start(address string) error

Start starts the server to handle connections.

type Summary

type Summary struct {
	Total, AlreadyStored, Sd, Blob, Err int
}

type Uploader

type Uploader struct {
	// contains filtered or unexported fields
}

func NewUploader

func NewUploader(db *db.SQL, store *store.DBBackedStore, workers int, skipExistsCheck bool) *Uploader

func (*Uploader) GetSummary

func (u *Uploader) GetSummary() Summary

func (*Uploader) Stop

func (u *Uploader) Stop()

func (*Uploader) Upload

func (u *Uploader) Upload(dirOrFilePath string) error