protocol

Documentation

Overview

Package protocol defines types for the storage protocol.

Index

• Constants
• Variables
• type Host
• type Storage
  • func NewStorage(host Host, db db.DB, storagePath string) *Storage
  • func (s *Storage) Authorize(ctx context.Context, pids [][]byte, fileHash []byte) error
  • func (s *Storage) PullFile(ctx context.Context, fileHash []byte, pid []byte) (err error)
  • func (s *Storage) StreamHandler(ctx context.Context, stream inet.Stream)

Constants

const ChunkSize = 1024

ChunkSize size of a chunk of data

Variables

var (
	// ErrUnauthorized is returned when a peer tries to access a file he
	// is not allowed to get.
	ErrUnauthorized = errors.New("peer not authorized for requested file")
)

Types

type Host

type Host = ihost.Host

Host represents a Stratumn Node host.

type Storage

type Storage struct {
	FileHandler file.Handler
	// contains filtered or unexported fields
}

Storage implements the storage protocol.

func NewStorage

func NewStorage(host Host, db db.DB, storagePath string) *Storage

NewStorage creates a new storage server.

func (*Storage) Authorize

func (s *Storage) Authorize(ctx context.Context, pids [][]byte, fileHash []byte) error

Authorize adds a list of peers to the authorized peers for a file hash.

func (*Storage) PullFile

func (s *Storage) PullFile(ctx context.Context, fileHash []byte, pid []byte) (err error)

PullFile pulls a file from a peer given the file hash if it has not already be downloaded.

func (*Storage) StreamHandler

func (s *Storage) StreamHandler(ctx context.Context, stream inet.Stream)

StreamHandler handles incoming messages from peers.