reflector

Documentation

Index

• Constants
• Variables
• type Client
  • func (c *Client) Close() error
  • func (c *Client) Connect(address string) error
  • func (c *Client) SendBlob(blob []byte) error
• type Server
  • func NewServer(store store.BlobStore) *Server
  • func (s *Server) Shutdown()
  • func (s *Server) Start(address string) error

Constants

const (
	// DefaultPort is the port the reflector server listens on if not passed in.
	DefaultPort = 5566
)

Variables

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

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

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 []byte) error

SendBlob sends a send blob request to the client.

type Server

type Server struct {
	// 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 listener to handle connections.