protocol

package
v0.14.0-beta.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 10, 2016 License: MPL-2.0, MIT Imports: 22 Imported by: 50

README

The BEPv1 Protocol

Latest Build API Documentation MIT License

This is the protocol implementation used by Syncthing.

License

MIT

Documentation

Overview 

Package protocol is a generated protocol buffer package.

It is generated from these files:
	bep.proto

It has these top-level messages:
	Hello
	Header
	ClusterConfig
	Folder
	Device
	Index
	IndexUpdate
	FileInfo
	BlockInfo
	Vector
	Counter
	Request
	Response
	DownloadProgress
	FileDownloadProgressUpdate
	Ping
	Close

Package protocol implements the Block Exchange Protocol.

Index

Constants

View Source 
const (
	// BlockSize is the standard ata block size (128 KiB)
	BlockSize = 128 << 10

	// MaxMessageLen is the largest message size allowed on the wire. (500 MB)
	MaxMessageLen = 500 * 1000 * 1000
)
View Source 
const (
	FlagFolderReadOnly            uint32 = 1 << 0
	FlagFolderIgnorePerms                = 1 << 1
	FlagFolderIgnoreDelete               = 1 << 2
	FlagFolderDisabledTempIndexes        = 1 << 3
	FlagFolderAll                        = 1<<4 - 1
)

ClusterConfigMessage.Folders flags

View Source 
const (
	FlagShareTrusted  uint32 = 1 << 0
	FlagShareReadOnly        = 1 << 1
	FlagIntroducer           = 1 << 2
	FlagShareBits            = 0x000000ff
)

ClusterConfigMessage.Folders.Devices flags

View Source 
const (
	// PingSendInterval is how often we make sure to send a message, by
	// triggering pings if necessary.
	PingSendInterval = 90 * time.Second
	// ReceiveTimeout is the longest we'll wait for a message from the other
	// side before closing the connection.
	ReceiveTimeout = 300 * time.Second
)
View Source 
const (
	FlagFromTemporary uint32 = 1 << iota
)

Request message flags

Variables

View Source 
var (
	ErrInvalidLengthBep = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowBep   = fmt.Errorf("proto: integer overflow")
)
View Source 
var (
	ErrNoError    error
	ErrGeneric    = errors.New("generic error")
	ErrNoSuchFile = errors.New("no such file")
	ErrInvalid    = errors.New("file is invalid")
)
View Source 
var (
	// ErrTooOldVersion12 is returned by ExchangeHello when the other side
	// speaks the older, incompatible version 0.12 of the protocol.
	ErrTooOldVersion12 = errors.New("the remote device speaks an older version of the protocol (v0.12) not compatible with this version")
	// ErrTooOldVersion13 is returned by ExchangeHello when the other side
	// speaks the older, incompatible version 0.12 of the protocol.
	ErrTooOldVersion13 = errors.New("the remote device speaks an older version of the protocol (v0.13) not compatible with this version")
	// ErrUnknownMagic is returned by ExchangeHellow when the other side
	// speaks something entirely unknown.
	ErrUnknownMagic = errors.New("the remote device speaks an unknown (newer?) version of the protocol")
)
View Source 
var (
	ErrClosed               = errors.New("connection closed")
	ErrTimeout              = errors.New("read timeout")
	ErrSwitchingConnections = errors.New("switching connections")
)
View Source 
var Compression_name = map[int32]string{
	0: "METADATA",
	1: "NEVER",
	2: "ALWAYS",
}
View Source 
var Compression_value = map[string]int32{
	"METADATA": 0,
	"NEVER":    1,
	"ALWAYS":   2,
}
View Source 
var ErrorCode_name = map[int32]string{
	0: "NO_ERROR",
	1: "GENERIC",
	2: "NO_SUCH_FILE",
	3: "INVALID_FILE",
}
View Source 
var ErrorCode_value = map[string]int32{
	"NO_ERROR":     0,
	"GENERIC":      1,
	"NO_SUCH_FILE": 2,
	"INVALID_FILE": 3,
}
View Source 
var FileDownloadProgressUpdateType_name = map[int32]string{
	0: "APPEND",
	1: "FORGET",
}
View Source 
var FileDownloadProgressUpdateType_value = map[string]int32{
	"APPEND": 0,
	"FORGET": 1,
}
View Source 
var FileInfoType_name = map[int32]string{
	0: "FILE",
	1: "DIRECTORY",
	2: "SYMLINK_FILE",
	3: "SYMLINK_DIRECTORY",
	4: "SYMLINK_UNKNOWN",
}
View Source 
var FileInfoType_value = map[string]int32{
	"FILE":              0,
	"DIRECTORY":         1,
	"SYMLINK_FILE":      2,
	"SYMLINK_DIRECTORY": 3,
	"SYMLINK_UNKNOWN":   4,
}
View Source 
var (
	HelloMessageMagic = uint32(0x2EA7D90B)
)
View Source 
var LocalDeviceID = DeviceID{0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff}
View Source 
var MessageCompression_name = map[int32]string{
	0: "NONE",
	1: "LZ4",
}
View Source 
var MessageCompression_value = map[string]int32{
	"NONE": 0,
	"LZ4":  1,
}
View Source 
var MessageType_name = map[int32]string{
	0: "CLUSTER_CONFIG",
	1: "INDEX",
	2: "INDEX_UPDATE",
	3: "REQUEST",
	4: "RESPONSE",
	5: "DOWNLOAD_PROGRESS",
	6: "PING",
	7: "CLOSE",
}
View Source 
var MessageType_value = map[string]int32{
	"CLUSTER_CONFIG":    0,
	"INDEX":             1,
	"INDEX_UPDATE":      2,
	"REQUEST":           3,
	"RESPONSE":          4,
	"DOWNLOAD_PROGRESS": 5,
	"PING":              6,
	"CLOSE":             7,
}
View Source 
var (
	Version13HelloMagic uint32 = 0x9F79BC40
)

Functions

func IsVersionMismatch added in v0.13.6 

func IsVersionMismatch(err error) bool

IsVersionMismatch returns true if the error is a reliable indication of a version mismatch that we might want to alert the user about.

func TotalInOut 

func TotalInOut() (int64, int64)

Types

type BlockInfo 

type BlockInfo struct {
	Offset int64  `protobuf:"varint,1,opt,name=offset,proto3" json:"offset,omitempty"`
	Size   int32  `protobuf:"varint,2,opt,name=size,proto3" json:"size,omitempty"`
	Hash   []byte `protobuf:"bytes,3,opt,name=hash,proto3" json:"hash,omitempty"`
}

func (*BlockInfo) Descriptor added in v0.14.0 

func (*BlockInfo) Descriptor() ([]byte, []int)

func (BlockInfo) IsEmpty added in v0.12.4 

func (b BlockInfo) IsEmpty() bool

IsEmpty returns true if the block is a full block of zeroes.

func (*BlockInfo) Marshal added in v0.14.0 

func (m *BlockInfo) Marshal() (data []byte, err error)

func (*BlockInfo) MarshalTo added in v0.14.0 

func (m *BlockInfo) MarshalTo(data []byte) (int, error)

func (*BlockInfo) ProtoMessage added in v0.14.0 

func (*BlockInfo) ProtoMessage()

func (*BlockInfo) ProtoSize added in v0.14.0 

func (m *BlockInfo) ProtoSize() (n int)

func (*BlockInfo) Reset added in v0.14.0 

func (m *BlockInfo) Reset()

func (BlockInfo) String 

func (b BlockInfo) String() string

func (*BlockInfo) Unmarshal added in v0.14.0 

func (m *BlockInfo) Unmarshal(data []byte) error

type Close added in v0.14.0 

type Close struct {
	Reason string `protobuf:"bytes,1,opt,name=reason,proto3" json:"reason,omitempty"`
}

func (*Close) Descriptor added in v0.14.0 

func (*Close) Descriptor() ([]byte, []int)

func (*Close) Marshal added in v0.14.0 

func (m *Close) Marshal() (data []byte, err error)

func (*Close) MarshalTo added in v0.14.0 

func (m *Close) MarshalTo(data []byte) (int, error)

func (*Close) ProtoMessage added in v0.14.0 

func (*Close) ProtoMessage()

func (*Close) ProtoSize added in v0.14.0 

func (m *Close) ProtoSize() (n int)

func (*Close) Reset added in v0.14.0 

func (m *Close) Reset()

func (*Close) String added in v0.14.0 

func (m *Close) String() string

func (*Close) Unmarshal added in v0.14.0 

func (m *Close) Unmarshal(data []byte) error

type ClusterConfig added in v0.14.0 

type ClusterConfig struct {
	Folders []Folder `protobuf:"bytes,1,rep,name=folders" json:"folders"`
}

func (*ClusterConfig) Descriptor added in v0.14.0 

func (*ClusterConfig) Descriptor() ([]byte, []int)

func (*ClusterConfig) Marshal added in v0.14.0 

func (m *ClusterConfig) Marshal() (data []byte, err error)

func (*ClusterConfig) MarshalTo added in v0.14.0 

func (m *ClusterConfig) MarshalTo(data []byte) (int, error)

func (*ClusterConfig) ProtoMessage added in v0.14.0 

func (*ClusterConfig) ProtoMessage()

func (*ClusterConfig) ProtoSize added in v0.14.0 

func (m *ClusterConfig) ProtoSize() (n int)

func (*ClusterConfig) Reset added in v0.14.0 

func (m *ClusterConfig) Reset()

func (*ClusterConfig) String added in v0.14.0 

func (m *ClusterConfig) String() string

func (*ClusterConfig) Unmarshal added in v0.14.0 

func (m *ClusterConfig) Unmarshal(data []byte) error

type Compression 

type Compression int32
const (
	CompressMetadata Compression = 0
	CompressNever    Compression = 1
	CompressAlways   Compression = 2
)

func (Compression) EnumDescriptor added in v0.14.0 

func (Compression) EnumDescriptor() ([]byte, []int)

func (Compression) GoString 

func (c Compression) GoString() string

func (Compression) MarshalText 

func (c Compression) MarshalText() ([]byte, error)

func (Compression) String 

func (x Compression) String() string

func (*Compression) UnmarshalText 

func (c *Compression) UnmarshalText(bs []byte) error

type Connection 

type Connection interface {
	Start()
	ID() DeviceID
	Name() string
	Index(folder string, files []FileInfo) error
	IndexUpdate(folder string, files []FileInfo) error
	Request(folder string, name string, offset int64, size int, hash []byte, fromTemporary bool) ([]byte, error)
	ClusterConfig(config ClusterConfig)
	DownloadProgress(folder string, updates []FileDownloadProgressUpdate)
	Statistics() Statistics
	Closed() bool
}

func NewConnection 

func NewConnection(deviceID DeviceID, reader io.Reader, writer io.Writer, receiver Model, name string, compress Compression) Connection

type Counter 

type Counter struct {
	ID    ShortID `protobuf:"varint,1,opt,name=id,proto3,customtype=ShortID" json:"id"`
	Value uint64  `protobuf:"varint,2,opt,name=value,proto3" json:"value,omitempty"`
}

func (*Counter) Descriptor added in v0.14.0 

func (*Counter) Descriptor() ([]byte, []int)

func (*Counter) Marshal added in v0.14.0 

func (m *Counter) Marshal() (data []byte, err error)

func (*Counter) MarshalTo added in v0.14.0 

func (m *Counter) MarshalTo(data []byte) (int, error)

func (*Counter) ProtoMessage added in v0.14.0 

func (*Counter) ProtoMessage()

func (*Counter) ProtoSize added in v0.14.0 

func (m *Counter) ProtoSize() (n int)

func (*Counter) Reset added in v0.14.0 

func (m *Counter) Reset()

func (*Counter) String added in v0.14.0 

func (m *Counter) String() string

func (*Counter) Unmarshal added in v0.14.0 

func (m *Counter) Unmarshal(data []byte) error

type Device 

type Device struct {
	ID              []byte      `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Name            string      `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	Addresses       []string    `protobuf:"bytes,3,rep,name=addresses" json:"addresses,omitempty"`
	Compression     Compression `protobuf:"varint,4,opt,name=compression,proto3,enum=protocol.Compression" json:"compression,omitempty"`
	CertName        string      `protobuf:"bytes,5,opt,name=cert_name,json=certName,proto3" json:"cert_name,omitempty"`
	MaxLocalVersion int64       `protobuf:"varint,6,opt,name=max_local_version,json=maxLocalVersion,proto3" json:"max_local_version,omitempty"`
	Introducer      bool        `protobuf:"varint,7,opt,name=introducer,proto3" json:"introducer,omitempty"`
}

func (*Device) Descriptor added in v0.14.0 

func (*Device) Descriptor() ([]byte, []int)

func (*Device) Marshal added in v0.14.0 

func (m *Device) Marshal() (data []byte, err error)

func (*Device) MarshalTo added in v0.14.0 

func (m *Device) MarshalTo(data []byte) (int, error)

func (*Device) ProtoMessage added in v0.14.0 

func (*Device) ProtoMessage()

func (*Device) ProtoSize added in v0.14.0 

func (m *Device) ProtoSize() (n int)

func (*Device) Reset added in v0.14.0 

func (m *Device) Reset()

func (*Device) String added in v0.14.0 

func (m *Device) String() string

func (*Device) Unmarshal added in v0.14.0 

func (m *Device) Unmarshal(data []byte) error

type DeviceID 

type DeviceID [32]byte

func DeviceIDFromBytes 

func DeviceIDFromBytes(bs []byte) DeviceID

func DeviceIDFromString 

func DeviceIDFromString(s string) (DeviceID, error)

func NewDeviceID 

func NewDeviceID(rawCert []byte) DeviceID

NewDeviceID generates a new device ID from the raw bytes of a certificate

func (DeviceID) Compare 

func (n DeviceID) Compare(other DeviceID) int

func (DeviceID) Equals 

func (n DeviceID) Equals(other DeviceID) bool

func (DeviceID) GoString 

func (n DeviceID) GoString() string

func (*DeviceID) MarshalText 

func (n *DeviceID) MarshalText() ([]byte, error)

func (DeviceID) Short 

func (n DeviceID) Short() ShortID

Short returns an integer representing bits 0-63 of the device ID.

func (DeviceID) String 

func (n DeviceID) String() string

String returns the canonical string representation of the device ID

func (*DeviceID) UnmarshalText 

func (n *DeviceID) UnmarshalText(bs []byte) error

type DownloadProgress added in v0.14.0 

type DownloadProgress struct {
	Folder  string                       `protobuf:"bytes,1,opt,name=folder,proto3" json:"folder,omitempty"`
	Updates []FileDownloadProgressUpdate `protobuf:"bytes,2,rep,name=updates" json:"updates"`
}

func (*DownloadProgress) Descriptor added in v0.14.0 

func (*DownloadProgress) Descriptor() ([]byte, []int)

func (*DownloadProgress) Marshal added in v0.14.0 

func (m *DownloadProgress) Marshal() (data []byte, err error)

func (*DownloadProgress) MarshalTo added in v0.14.0 

func (m *DownloadProgress) MarshalTo(data []byte) (int, error)

func (*DownloadProgress) ProtoMessage added in v0.14.0 

func (*DownloadProgress) ProtoMessage()

func (*DownloadProgress) ProtoSize added in v0.14.0 

func (m *DownloadProgress) ProtoSize() (n int)

func (*DownloadProgress) Reset added in v0.14.0 

func (m *DownloadProgress) Reset()

func (*DownloadProgress) String added in v0.14.0 

func (m *DownloadProgress) String() string

func (*DownloadProgress) Unmarshal added in v0.14.0 

func (m *DownloadProgress) Unmarshal(data []byte) error

type ErrorCode added in v0.14.0 

type ErrorCode int32
const (
	ErrorCodeNoError     ErrorCode = 0
	ErrorCodeGeneric     ErrorCode = 1
	ErrorCodeNoSuchFile  ErrorCode = 2
	ErrorCodeInvalidFile ErrorCode = 3
)

func (ErrorCode) EnumDescriptor added in v0.14.0 

func (ErrorCode) EnumDescriptor() ([]byte, []int)

func (ErrorCode) String added in v0.14.0 

func (x ErrorCode) String() string

type FileDownloadProgressUpdate added in v0.13.0 

type FileDownloadProgressUpdate struct {
	UpdateType   FileDownloadProgressUpdateType `` /* 137-byte string literal not displayed */
	Name         string                         `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	Version      Vector                         `protobuf:"bytes,3,opt,name=version" json:"version"`
	BlockIndexes []int32                        `protobuf:"varint,4,rep,name=block_indexes,json=blockIndexes" json:"block_indexes,omitempty"`
}

func (*FileDownloadProgressUpdate) Descriptor added in v0.14.0 

func (*FileDownloadProgressUpdate) Descriptor() ([]byte, []int)

func (*FileDownloadProgressUpdate) Marshal added in v0.14.0 

func (m *FileDownloadProgressUpdate) Marshal() (data []byte, err error)

func (*FileDownloadProgressUpdate) MarshalTo added in v0.14.0 

func (m *FileDownloadProgressUpdate) MarshalTo(data []byte) (int, error)

func (*FileDownloadProgressUpdate) ProtoMessage added in v0.14.0 

func (*FileDownloadProgressUpdate) ProtoMessage()

func (*FileDownloadProgressUpdate) ProtoSize added in v0.14.0 

func (m *FileDownloadProgressUpdate) ProtoSize() (n int)

func (*FileDownloadProgressUpdate) Reset added in v0.14.0 

func (m *FileDownloadProgressUpdate) Reset()

func (*FileDownloadProgressUpdate) String added in v0.14.0 

func (m *FileDownloadProgressUpdate) String() string

func (*FileDownloadProgressUpdate) Unmarshal added in v0.14.0 

func (m *FileDownloadProgressUpdate) Unmarshal(data []byte) error

type FileDownloadProgressUpdateType added in v0.14.0 

type FileDownloadProgressUpdateType int32
const (
	UpdateTypeAppend FileDownloadProgressUpdateType = 0
	UpdateTypeForget FileDownloadProgressUpdateType = 1
)

func (FileDownloadProgressUpdateType) EnumDescriptor added in v0.14.0 

func (FileDownloadProgressUpdateType) EnumDescriptor() ([]byte, []int)

func (FileDownloadProgressUpdateType) String added in v0.14.0 

func (x FileDownloadProgressUpdateType) String() string

type FileInfo 

type FileInfo struct {
	Name          string       `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Type          FileInfoType `protobuf:"varint,2,opt,name=type,proto3,enum=protocol.FileInfoType" json:"type,omitempty"`
	Size          int64        `protobuf:"varint,3,opt,name=size,proto3" json:"size,omitempty"`
	Permissions   uint32       `protobuf:"varint,4,opt,name=permissions,proto3" json:"permissions,omitempty"`
	Modified      int64        `protobuf:"varint,5,opt,name=modified,proto3" json:"modified,omitempty"`
	Deleted       bool         `protobuf:"varint,6,opt,name=deleted,proto3" json:"deleted,omitempty"`
	Invalid       bool         `protobuf:"varint,7,opt,name=invalid,proto3" json:"invalid,omitempty"`
	NoPermissions bool         `protobuf:"varint,8,opt,name=no_permissions,json=noPermissions,proto3" json:"no_permissions,omitempty"`
	Version       Vector       `protobuf:"bytes,9,opt,name=version" json:"version"`
	LocalVersion  int64        `protobuf:"varint,10,opt,name=local_version,json=localVersion,proto3" json:"local_version,omitempty"`
	Blocks        []BlockInfo  `protobuf:"bytes,16,rep,name=Blocks,json=blocks" json:"Blocks"`
}

func (*FileInfo) Descriptor added in v0.14.0 

func (*FileInfo) Descriptor() ([]byte, []int)

func (FileInfo) FileName added in v0.14.0 

func (f FileInfo) FileName() string

func (FileInfo) FileSize added in v0.14.0 

func (f FileInfo) FileSize() int64

func (FileInfo) HasPermissionBits 

func (f FileInfo) HasPermissionBits() bool

func (FileInfo) IsDeleted 

func (f FileInfo) IsDeleted() bool

func (FileInfo) IsDirectory 

func (f FileInfo) IsDirectory() bool

func (FileInfo) IsInvalid 

func (f FileInfo) IsInvalid() bool
func (f FileInfo) IsSymlink() bool

func (*FileInfo) Marshal added in v0.14.0 

func (m *FileInfo) Marshal() (data []byte, err error)

func (*FileInfo) MarshalTo added in v0.14.0 

func (m *FileInfo) MarshalTo(data []byte) (int, error)

func (*FileInfo) ProtoMessage added in v0.14.0 

func (*FileInfo) ProtoMessage()

func (*FileInfo) ProtoSize added in v0.14.0 

func (m *FileInfo) ProtoSize() (n int)

func (*FileInfo) Reset added in v0.14.0 

func (m *FileInfo) Reset()

func (FileInfo) String 

func (f FileInfo) String() string

func (*FileInfo) Unmarshal added in v0.14.0 

func (m *FileInfo) Unmarshal(data []byte) error

func (FileInfo) WinsConflict 

func (f FileInfo) WinsConflict(other FileInfo) bool

WinsConflict returns true if "f" is the one to choose when it is in conflict with "other".

type FileInfoType added in v0.14.0 

type FileInfoType int32
const (
	FileInfoTypeFile             FileInfoType = 0
	FileInfoTypeDirectory        FileInfoType = 1
	FileInfoTypeSymlinkFile      FileInfoType = 2
	FileInfoTypeSymlinkDirectory FileInfoType = 3
	FileInfoTypeSymlinkUnknown   FileInfoType = 4
)

func (FileInfoType) EnumDescriptor added in v0.14.0 

func (FileInfoType) EnumDescriptor() ([]byte, []int)

func (FileInfoType) String added in v0.14.0 

func (x FileInfoType) String() string

type Folder 

type Folder struct {
	ID                 string   `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Label              string   `protobuf:"bytes,2,opt,name=label,proto3" json:"label,omitempty"`
	ReadOnly           bool     `protobuf:"varint,3,opt,name=read_only,json=readOnly,proto3" json:"read_only,omitempty"`
	IgnorePermissions  bool     `protobuf:"varint,4,opt,name=ignore_permissions,json=ignorePermissions,proto3" json:"ignore_permissions,omitempty"`
	IgnoreDelete       bool     `protobuf:"varint,5,opt,name=ignore_delete,json=ignoreDelete,proto3" json:"ignore_delete,omitempty"`
	DisableTempIndexes bool     `protobuf:"varint,6,opt,name=disable_temp_indexes,json=disableTempIndexes,proto3" json:"disable_temp_indexes,omitempty"`
	Devices            []Device `protobuf:"bytes,16,rep,name=devices" json:"devices"`
}

func (*Folder) Descriptor added in v0.14.0 

func (*Folder) Descriptor() ([]byte, []int)

func (*Folder) Marshal added in v0.14.0 

func (m *Folder) Marshal() (data []byte, err error)

func (*Folder) MarshalTo added in v0.14.0 

func (m *Folder) MarshalTo(data []byte) (int, error)

func (*Folder) ProtoMessage added in v0.14.0 

func (*Folder) ProtoMessage()

func (*Folder) ProtoSize added in v0.14.0 

func (m *Folder) ProtoSize() (n int)

func (*Folder) Reset added in v0.14.0 

func (m *Folder) Reset()

func (*Folder) String added in v0.14.0 

func (m *Folder) String() string

func (*Folder) Unmarshal added in v0.14.0 

func (m *Folder) Unmarshal(data []byte) error
type Header struct {
	Type        MessageType        `protobuf:"varint,1,opt,name=type,proto3,enum=protocol.MessageType" json:"type,omitempty"`
	Compression MessageCompression `protobuf:"varint,2,opt,name=compression,proto3,enum=protocol.MessageCompression" json:"compression,omitempty"`
}

func (*Header) Descriptor added in v0.14.0 

func (*Header) Descriptor() ([]byte, []int)

func (*Header) Marshal added in v0.14.0 

func (m *Header) Marshal() (data []byte, err error)

func (*Header) MarshalTo added in v0.14.0 

func (m *Header) MarshalTo(data []byte) (int, error)

func (*Header) ProtoMessage added in v0.14.0 

func (*Header) ProtoMessage()

func (*Header) ProtoSize added in v0.14.0 

func (m *Header) ProtoSize() (n int)

func (*Header) Reset added in v0.14.0 

func (m *Header) Reset()

func (*Header) String added in v0.14.0 

func (m *Header) String() string

func (*Header) Unmarshal added in v0.14.0 

func (m *Header) Unmarshal(data []byte) error

type Hello added in v0.14.0 

type Hello struct {
	DeviceName    string `protobuf:"bytes,1,opt,name=device_name,json=deviceName,proto3" json:"device_name,omitempty"`
	ClientName    string `protobuf:"bytes,2,opt,name=client_name,json=clientName,proto3" json:"client_name,omitempty"`
	ClientVersion string `protobuf:"bytes,3,opt,name=client_version,json=clientVersion,proto3" json:"client_version,omitempty"`
}

func (*Hello) Descriptor added in v0.14.0 

func (*Hello) Descriptor() ([]byte, []int)

func (Hello) Magic added in v0.14.0 

func (m Hello) Magic() uint32

func (*Hello) Marshal added in v0.14.0 

func (m *Hello) Marshal() (data []byte, err error)

func (*Hello) MarshalTo added in v0.14.0 

func (m *Hello) MarshalTo(data []byte) (int, error)

func (*Hello) ProtoMessage added in v0.14.0 

func (*Hello) ProtoMessage()

func (*Hello) ProtoSize added in v0.14.0 

func (m *Hello) ProtoSize() (n int)

func (*Hello) Reset added in v0.14.0 

func (m *Hello) Reset()

func (*Hello) String added in v0.14.0 

func (m *Hello) String() string

func (*Hello) Unmarshal added in v0.14.0 

func (m *Hello) Unmarshal(data []byte) error

type HelloIntf added in v0.14.0 

type HelloIntf interface {
	Magic() uint32
	Marshal() ([]byte, error)
}

The HelloIntf interface is implemented by the version specific hello message. It knows its magic number and how to serialize itself to a byte buffer.

type HelloResult added in v0.13.6 

type HelloResult struct {
	DeviceName    string
	ClientName    string
	ClientVersion string
}

The HelloResult is the non version specific interpretation of the other side's Hello message.

func ExchangeHello added in v0.13.6 

func ExchangeHello(c io.ReadWriter, h HelloIntf) (HelloResult, error)

type Index added in v0.14.0 

type Index struct {
	Folder string     `protobuf:"bytes,1,opt,name=folder,proto3" json:"folder,omitempty"`
	Files  []FileInfo `protobuf:"bytes,2,rep,name=files" json:"files"`
}

func (*Index) Descriptor added in v0.14.0 

func (*Index) Descriptor() ([]byte, []int)

func (*Index) Marshal added in v0.14.0 

func (m *Index) Marshal() (data []byte, err error)

func (*Index) MarshalTo added in v0.14.0 

func (m *Index) MarshalTo(data []byte) (int, error)

func (*Index) ProtoMessage added in v0.14.0 

func (*Index) ProtoMessage()

func (*Index) ProtoSize added in v0.14.0 

func (m *Index) ProtoSize() (n int)

func (*Index) Reset added in v0.14.0 

func (m *Index) Reset()

func (*Index) String added in v0.14.0 

func (m *Index) String() string

func (*Index) Unmarshal added in v0.14.0 

func (m *Index) Unmarshal(data []byte) error

type IndexUpdate added in v0.14.0 

type IndexUpdate struct {
	Folder string     `protobuf:"bytes,1,opt,name=folder,proto3" json:"folder,omitempty"`
	Files  []FileInfo `protobuf:"bytes,2,rep,name=files" json:"files"`
}

func (*IndexUpdate) Descriptor added in v0.14.0 

func (*IndexUpdate) Descriptor() ([]byte, []int)

func (*IndexUpdate) Marshal added in v0.14.0 

func (m *IndexUpdate) Marshal() (data []byte, err error)

func (*IndexUpdate) MarshalTo added in v0.14.0 

func (m *IndexUpdate) MarshalTo(data []byte) (int, error)

func (*IndexUpdate) ProtoMessage added in v0.14.0 

func (*IndexUpdate) ProtoMessage()

func (*IndexUpdate) ProtoSize added in v0.14.0 

func (m *IndexUpdate) ProtoSize() (n int)

func (*IndexUpdate) Reset added in v0.14.0 

func (m *IndexUpdate) Reset()

func (*IndexUpdate) String added in v0.14.0 

func (m *IndexUpdate) String() string

func (*IndexUpdate) Unmarshal added in v0.14.0 

func (m *IndexUpdate) Unmarshal(data []byte) error

type MessageCompression added in v0.14.0 

type MessageCompression int32
const (
	MessageCompressionNone MessageCompression = 0
	MessageCompressionLZ4  MessageCompression = 1
)

func (MessageCompression) EnumDescriptor added in v0.14.0 

func (MessageCompression) EnumDescriptor() ([]byte, []int)

func (MessageCompression) String added in v0.14.0 

func (x MessageCompression) String() string

type MessageType added in v0.14.0 

type MessageType int32

func (MessageType) EnumDescriptor added in v0.14.0 

func (MessageType) EnumDescriptor() ([]byte, []int)

func (MessageType) String added in v0.14.0 

func (x MessageType) String() string

type Model 

type Model interface {
	// An index was received from the peer device
	Index(deviceID DeviceID, folder string, files []FileInfo)
	// An index update was received from the peer device
	IndexUpdate(deviceID DeviceID, folder string, files []FileInfo)
	// A request was made by the peer device
	Request(deviceID DeviceID, folder string, name string, offset int64, hash []byte, fromTemporary bool, buf []byte) error
	// A cluster configuration message was received
	ClusterConfig(deviceID DeviceID, config ClusterConfig)
	// The peer device closed the connection
	Close(deviceID DeviceID, err error)
	// The peer device sent progress updates for the files it is currently downloading
	DownloadProgress(deviceID DeviceID, folder string, updates []FileDownloadProgressUpdate)
}

type Ordering 

type Ordering int

Ordering represents the relationship between two Vectors. 

const (
	Equal Ordering = iota
	Greater
	Lesser
	ConcurrentLesser
	ConcurrentGreater
)

type Ping added in v0.14.0 

type Ping struct {
}

func (*Ping) Descriptor added in v0.14.0 

func (*Ping) Descriptor() ([]byte, []int)

func (*Ping) Marshal added in v0.14.0 

func (m *Ping) Marshal() (data []byte, err error)

func (*Ping) MarshalTo added in v0.14.0 

func (m *Ping) MarshalTo(data []byte) (int, error)

func (*Ping) ProtoMessage added in v0.14.0 

func (*Ping) ProtoMessage()

func (*Ping) ProtoSize added in v0.14.0 

func (m *Ping) ProtoSize() (n int)

func (*Ping) Reset added in v0.14.0 

func (m *Ping) Reset()

func (*Ping) String added in v0.14.0 

func (m *Ping) String() string

func (*Ping) Unmarshal added in v0.14.0 

func (m *Ping) Unmarshal(data []byte) error

type Request added in v0.14.0 

type Request struct {
	ID            int32  `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	Folder        string `protobuf:"bytes,2,opt,name=folder,proto3" json:"folder,omitempty"`
	Name          string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	Offset        int64  `protobuf:"varint,4,opt,name=offset,proto3" json:"offset,omitempty"`
	Size          int32  `protobuf:"varint,5,opt,name=size,proto3" json:"size,omitempty"`
	Hash          []byte `protobuf:"bytes,6,opt,name=hash,proto3" json:"hash,omitempty"`
	FromTemporary bool   `protobuf:"varint,7,opt,name=from_temporary,json=fromTemporary,proto3" json:"from_temporary,omitempty"`
}

func (*Request) Descriptor added in v0.14.0 

func (*Request) Descriptor() ([]byte, []int)

func (*Request) Marshal added in v0.14.0 

func (m *Request) Marshal() (data []byte, err error)

func (*Request) MarshalTo added in v0.14.0 

func (m *Request) MarshalTo(data []byte) (int, error)

func (*Request) ProtoMessage added in v0.14.0 

func (*Request) ProtoMessage()

func (*Request) ProtoSize added in v0.14.0 

func (m *Request) ProtoSize() (n int)

func (*Request) Reset added in v0.14.0 

func (m *Request) Reset()

func (*Request) String added in v0.14.0 

func (m *Request) String() string

func (*Request) Unmarshal added in v0.14.0 

func (m *Request) Unmarshal(data []byte) error

type Response added in v0.14.0 

type Response struct {
	ID   int32     `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	Data []byte    `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
	Code ErrorCode `protobuf:"varint,3,opt,name=code,proto3,enum=protocol.ErrorCode" json:"code,omitempty"`
}

func (*Response) Descriptor added in v0.14.0 

func (*Response) Descriptor() ([]byte, []int)

func (*Response) Marshal added in v0.14.0 

func (m *Response) Marshal() (data []byte, err error)

func (*Response) MarshalTo added in v0.14.0 

func (m *Response) MarshalTo(data []byte) (int, error)

func (*Response) ProtoMessage added in v0.14.0 

func (*Response) ProtoMessage()

func (*Response) ProtoSize added in v0.14.0 

func (m *Response) ProtoSize() (n int)

func (*Response) Reset added in v0.14.0 

func (m *Response) Reset()

func (*Response) String added in v0.14.0 

func (m *Response) String() string

func (*Response) Unmarshal added in v0.14.0 

func (m *Response) Unmarshal(data []byte) error

type ShortID added in v0.12.16 

type ShortID uint64

func (ShortID) String added in v0.12.16 

func (s ShortID) String() string

type Statistics 

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

type Vector 

type Vector struct {
	Counters []Counter `protobuf:"bytes,1,rep,name=counters" json:"counters"`
}

func (Vector) Compare 

func (v Vector) Compare(b Vector) Ordering

Compare returns the Ordering that describes a's relation to b.

func (Vector) Concurrent 

func (v Vector) Concurrent(b Vector) bool

Concurrent returns true when the two vectors are concurrent.

func (Vector) Copy 

func (v Vector) Copy() Vector

Copy returns an identical vector that is not shared with v.

func (Vector) Counter 

func (v Vector) Counter(id ShortID) uint64

Counter returns the current value of the given counter ID.

func (*Vector) Descriptor added in v0.14.0 

func (*Vector) Descriptor() ([]byte, []int)

func (Vector) Equal 

func (v Vector) Equal(b Vector) bool

Equal returns true when the two vectors are equivalent.

func (Vector) GreaterEqual 

func (v Vector) GreaterEqual(b Vector) bool

GreaterEqual returns true when the two vectors are equivalent or v is Greater than b.

func (Vector) LesserEqual 

func (v Vector) LesserEqual(b Vector) bool

LesserEqual returns true when the two vectors are equivalent or v is Lesser than b.

func (*Vector) Marshal added in v0.14.0 

func (m *Vector) Marshal() (data []byte, err error)

func (*Vector) MarshalTo added in v0.14.0 

func (m *Vector) MarshalTo(data []byte) (int, error)

func (Vector) Merge 

func (v Vector) Merge(b Vector) Vector

Merge returns the vector containing the maximum indexes from v and b. If it is possible, the vector v is updated and returned. If it is not, a copy will be created, updated and returned.

func (*Vector) ProtoMessage added in v0.14.0 

func (*Vector) ProtoMessage()

func (*Vector) ProtoSize added in v0.14.0 

func (m *Vector) ProtoSize() (n int)

func (*Vector) Reset added in v0.14.0 

func (m *Vector) Reset()

func (*Vector) String added in v0.14.0 

func (m *Vector) String() string

func (*Vector) Unmarshal added in v0.14.0 

func (m *Vector) Unmarshal(data []byte) error

func (Vector) Update 

func (v Vector) Update(id ShortID) Vector

Update returns a Vector with the index for the specific ID incremented by one. If it is possible, the vector v is updated and returned. If it is not, a copy will be created, updated and returned.

type Version13HelloMessage added in v0.13.6 

type Version13HelloMessage struct {
	DeviceName    string // max:64
	ClientName    string // max:64
	ClientVersion string // max:64
}

func (Version13HelloMessage) Magic added in v0.13.6 

func (m Version13HelloMessage) Magic() uint32

func (Version13HelloMessage) Marshal added in v0.13.6 

func (m Version13HelloMessage) Marshal() ([]byte, error)

func (Version13HelloMessage) MarshalXDR added in v0.13.6 

func (o Version13HelloMessage) MarshalXDR() ([]byte, error)

func (Version13HelloMessage) MarshalXDRInto added in v0.13.6 

func (o Version13HelloMessage) MarshalXDRInto(m *xdr.Marshaller) error

func (Version13HelloMessage) MustMarshalXDR added in v0.13.6 

func (o Version13HelloMessage) MustMarshalXDR() []byte

func (*Version13HelloMessage) UnmarshalXDR added in v0.13.6 

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

func (*Version13HelloMessage) UnmarshalXDRFrom added in v0.13.6 

func (o *Version13HelloMessage) UnmarshalXDRFrom(u *xdr.Unmarshaller) error

func (Version13HelloMessage) XDRSize added in v0.13.6 

func (o Version13HelloMessage) XDRSize() int

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.