protocol

Documentation

Overview

Package protocol implements the Block Exchange Protocol.

Index

• Constants
• Variables
• type BlockInfo
  • func (o *BlockInfo) DecodeXDR(r io.Reader) error
  • func (o BlockInfo) EncodeXDR(w io.Writer) (int, error)
  • func (o BlockInfo) MarshalXDR() []byte
  • func (o *BlockInfo) UnmarshalXDR(bs []byte) error
• type Connection
  • func NewConnection(nodeID string, reader io.Reader, writer io.Writer, receiver Model, ...) *Connection
  • func (c *Connection) ID() string
  • func (c *Connection) Index(repo string, idx []FileInfo)
  • func (c *Connection) Option(key string) string
  • func (c *Connection) Request(repo string, name string, offset int64, size int) ([]byte, error)
  • func (c *Connection) Statistics() Statistics
• type FileInfo
  • func (o *FileInfo) DecodeXDR(r io.Reader) error
  • func (o FileInfo) EncodeXDR(w io.Writer) (int, error)
  • func (o FileInfo) MarshalXDR() []byte
  • func (o *FileInfo) UnmarshalXDR(bs []byte) error
• type IndexMessage
  • func (o *IndexMessage) DecodeXDR(r io.Reader) error
  • func (o IndexMessage) EncodeXDR(w io.Writer) (int, error)
  • func (o IndexMessage) MarshalXDR() []byte
  • func (o *IndexMessage) UnmarshalXDR(bs []byte) error
• type Model
• type Option
  • func (o *Option) DecodeXDR(r io.Reader) error
  • func (o Option) EncodeXDR(w io.Writer) (int, error)
  • func (o Option) MarshalXDR() []byte
  • func (o *Option) UnmarshalXDR(bs []byte) error
• type OptionsMessage
  • func (o *OptionsMessage) DecodeXDR(r io.Reader) error
  • func (o OptionsMessage) EncodeXDR(w io.Writer) (int, error)
  • func (o OptionsMessage) MarshalXDR() []byte
  • func (o *OptionsMessage) UnmarshalXDR(bs []byte) error
• type RequestMessage
  • func (o *RequestMessage) DecodeXDR(r io.Reader) error
  • func (o RequestMessage) EncodeXDR(w io.Writer) (int, error)
  • func (o RequestMessage) MarshalXDR() []byte
  • func (o *RequestMessage) UnmarshalXDR(bs []byte) error
• type Statistics

Constants

const (
	FlagDeleted uint32 = 1 << 12
	FlagInvalid        = 1 << 13
)

const BlockSize = 128 * 1024

Variables

var (
	ErrClusterHash = fmt.Errorf("configuration error: mismatched cluster hash")
	ErrClosed      = errors.New("connection closed")
)

Types

type BlockInfo

type BlockInfo struct {
	Size uint32
	Hash []byte // max:64
}

func (*BlockInfo) DecodeXDR

func (o *BlockInfo) DecodeXDR(r io.Reader) error

func (BlockInfo) EncodeXDR

func (o BlockInfo) EncodeXDR(w io.Writer) (int, error)

func (BlockInfo) MarshalXDR

func (o BlockInfo) MarshalXDR() []byte

func (*BlockInfo) UnmarshalXDR

func (o *BlockInfo) UnmarshalXDR(bs []byte) error

type Connection

type Connection struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func NewConnection

func NewConnection(nodeID string, reader io.Reader, writer io.Writer, receiver Model, options map[string]string) *Connection

func (*Connection) ID

func (c *Connection) ID() string

func (*Connection) Index

func (c *Connection) Index(repo string, idx []FileInfo)

Index writes the list of file information to the connected peer node

func (*Connection) Option

func (c *Connection) Option(key string) string

func (*Connection) Request

func (c *Connection) Request(repo string, name string, offset int64, size int) ([]byte, error)

Request returns the bytes for the specified block after fetching them from the connected peer.

func (*Connection) Statistics

func (c *Connection) Statistics() Statistics

type FileInfo

type FileInfo struct {
	Name     string // max:1024
	Flags    uint32
	Modified int64
	Version  uint32
	Blocks   []BlockInfo // max:100000
}

func (*FileInfo) DecodeXDR

func (o *FileInfo) DecodeXDR(r io.Reader) error

func (FileInfo) EncodeXDR

func (o FileInfo) EncodeXDR(w io.Writer) (int, error)

func (FileInfo) MarshalXDR

func (o FileInfo) MarshalXDR() []byte

func (*FileInfo) UnmarshalXDR

func (o *FileInfo) UnmarshalXDR(bs []byte) error

type IndexMessage

type IndexMessage struct {
	Repository string     // max:64
	Files      []FileInfo // max:100000
}

func (*IndexMessage) DecodeXDR

func (o *IndexMessage) DecodeXDR(r io.Reader) error

func (IndexMessage) EncodeXDR

func (o IndexMessage) EncodeXDR(w io.Writer) (int, error)

func (IndexMessage) MarshalXDR

func (o IndexMessage) MarshalXDR() []byte

func (*IndexMessage) UnmarshalXDR

func (o *IndexMessage) UnmarshalXDR(bs []byte) error

type Model

type Model interface {
	// An index was received from the peer node
	Index(nodeID string, files []FileInfo)
	// An index update was received from the peer node
	IndexUpdate(nodeID string, files []FileInfo)
	// A request was made by the peer node
	Request(nodeID, repo string, name string, offset int64, size int) ([]byte, error)
	// The peer node closed the connection
	Close(nodeID string, err error)
}

type Option

type Option struct {
	Key   string // max:64
	Value string // max:1024
}

func (*Option) DecodeXDR

func (o *Option) DecodeXDR(r io.Reader) error

func (Option) EncodeXDR

func (o Option) EncodeXDR(w io.Writer) (int, error)

func (Option) MarshalXDR

func (o Option) MarshalXDR() []byte

func (*Option) UnmarshalXDR

func (o *Option) UnmarshalXDR(bs []byte) error

type OptionsMessage

type OptionsMessage struct {
	Options []Option // max:64
}

func (*OptionsMessage) DecodeXDR

func (o *OptionsMessage) DecodeXDR(r io.Reader) error

func (OptionsMessage) EncodeXDR

func (o OptionsMessage) EncodeXDR(w io.Writer) (int, error)

func (OptionsMessage) MarshalXDR

func (o OptionsMessage) MarshalXDR() []byte

func (*OptionsMessage) UnmarshalXDR

func (o *OptionsMessage) UnmarshalXDR(bs []byte) error

type RequestMessage

type RequestMessage struct {
	Repository string // max:64
	Name       string // max:1024
	Offset     uint64
	Size       uint32
}

func (*RequestMessage) DecodeXDR

func (o *RequestMessage) DecodeXDR(r io.Reader) error

func (RequestMessage) EncodeXDR

func (o RequestMessage) EncodeXDR(w io.Writer) (int, error)

func (RequestMessage) MarshalXDR

func (o RequestMessage) MarshalXDR() []byte

func (*RequestMessage) UnmarshalXDR

func (o *RequestMessage) UnmarshalXDR(bs []byte) error

type Statistics

type Statistics struct {
	At            time.Time
	InBytesTotal  int
	OutBytesTotal int
}