storage

package

v0.0.0-...-1538d9d Latest Latest Go to latest Published: Mar 28, 2021 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/PoCInnovation/PoC2Peer

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
type Chunk
- func FileDataToChunks(fileData []byte, chunkSize int) (chunks []Chunk)
- func NewChunkFromData(id ChunkID, size int, data []byte) Chunk
- func (c *Chunk) ID() ChunkID
type ChunkID
type ChunkIDs
- func (a ChunkIDs) Len() int
- func (a ChunkIDs) Less(i, j int) bool
- func (a ChunkIDs) Swap(i, j int)
type FileHash
- func NewHashFromFile(data []byte) FileHash
- func (h FileHash) Decode() string
- func (h FileHash) Eq(lhs FileHash) bool
- func (h FileHash) String() string
type FileHashTmp
- func (f FileHashTmp) String() string
type FileID
type FileState
type LocalStorage
- func NewP2PStorage() LocalStorage
type LocalStorageConfig
type P2PFile
- func NewFile(hash FileHash, state FileState, fileData []byte, chunkSize int) P2PFile
- func (f *P2PFile) AddChunks(chunks []Chunk) error
- func (f P2PFile) Complete() bool
- func (f *P2PFile) DeleteData()
- func (f P2PFile) GetChunksIDs() []ChunkID
- func (f *P2PFile) GetData() []byte
- func (f P2PFile) GetRequestedChunks(ids []ChunkID) []Chunk
- func (f *P2PFile) UpdateData()
type P2PFileStorage
type P2PRemoteStorage
- func NewP2PRemoteStorage() *P2PRemoteStorage
- func (s P2PRemoteStorage) AddFileChunksForPeer(peer PeerID, hash FileID, chunkIDS []ChunkID, FileSize int) error
- func (s P2PRemoteStorage) GetFileSize(hash FileID) (int, error)
- func (s P2PRemoteStorage) GetPeersFileChunks(hash FileID) (map[PeerID][]ChunkID, error)
type P2PStorage
- func (s *P2PStorage) AddFile(fileData []byte) (FileID, error)
- func (s *P2PStorage) AddReceivedFileChunks(hash FileID, chunks []Chunk) error
- func (s *P2PStorage) DeleteData(hash FileID) error
- func (s *P2PStorage) GetChunkIDsInStorage(hash FileID) ([]ChunkID, error)
- func (s *P2PStorage) GetFileData(hash FileID) ([]byte, error)
- func (s *P2PStorage) GetRequestedChunks(hash FileID, ids []ChunkID) ([]Chunk, error)
type PeerID
type PeerStorage

Constants ¶

View Source

const LocalStorageSize = 100

Variables ¶

View Source

var FILENOTFOUND = errors.New("P2PFile not in storage")

Functions ¶

This section is empty.

Types ¶

func FileDataToChunks ¶

func FileDataToChunks(fileData []byte, chunkSize int) (chunks []Chunk)

FileDataToChunks: Transform array of bytes (content of a file) into Chunk's array with 'chunkSize' size.

func NewChunkFromData ¶

func NewChunkFromData(id ChunkID, size int, data []byte) Chunk

func (*Chunk) ID ¶

func (c *Chunk) ID() ChunkID

func (ChunkIDs) Len ¶

func (a ChunkIDs) Len() int

func (ChunkIDs) Less ¶

func (a ChunkIDs) Less(i, j int) bool

func (ChunkIDs) Swap ¶

func (a ChunkIDs) Swap(i, j int)

func NewHashFromFile ¶

func NewHashFromFile(data []byte) FileHash

NewHashFromFile: Create a New Hashfrom file's content with SHA256

func (FileHash) Decode ¶

func (h FileHash) Decode() string

func (FileHash) Eq ¶

func (h FileHash) Eq(lhs FileHash) bool

Eq: Compare two FileHash

func (FileHash) String ¶

func (h FileHash) String() string

String: Return string representation from FileHash

type FileHashTmp ¶

type FileHashTmp int

func (FileHashTmp) String ¶

func (f FileHashTmp) String() string

type FileID ¶

type FileID interface {
	String() string
}

type LocalStorage ¶

type LocalStorage interface {
	AddFile(fileData []byte) (FileID, error)
	AddReceivedFileChunks(hash FileID, chunks []Chunk) error
	GetRequestedChunks(hash FileID, ids []ChunkID) ([]Chunk, error)
	GetChunkIDsInStorage(hash FileID) ([]ChunkID, error)
	GetFileData(hash FileID) ([]byte, error)
	DeleteData(hash FileID) error
}

func NewP2PStorage ¶

func NewP2PStorage() LocalStorage

type LocalStorageConfig ¶

type LocalStorageConfig struct {
	ChunkSize int
}

type P2PFile ¶

type P2PFile struct {
	Hash   FileHash
	State  FileState
	Data   []byte
	Chunks map[ChunkID]Chunk
}

P2PFile: Represent a P2PFile with all basic file infos.

Hash: unique ID for the file based on file content
state: FileState representing if the file is complete, updated or unchanged.
Data: File content formed with chunks' data. Used to avoid excess data merging when requesting data.
Chunks: All stored Chunks accesible by ChunkID.

func (*P2PFile) AddChunks ¶

func (f *P2PFile) AddChunks(chunks []Chunk) error

TODO

func (P2PFile) Complete ¶

func (f P2PFile) Complete() bool

Complete: Check P2PFile state, return true if file is completed.

func (*P2PFile) DeleteData ¶

func (f *P2PFile) DeleteData()

DeleteData: Delete file Data to free ressources

func (P2PFile) GetChunksIDs ¶

func (f P2PFile) GetChunksIDs() []ChunkID

GetChunksIDs: Return all ChunkID's in a P2PFile.

func (*P2PFile) GetData ¶

func (f *P2PFile) GetData() []byte

GetData: Return stored data in a P2PFile. if the file is completed or unchanged since last call to GetData, directly return stored data. otherwise (FileState = FSUpdated), call UpdateData to reform data from received Chunk.

func (P2PFile) GetRequestedChunks ¶

func (f P2PFile) GetRequestedChunks(ids []ChunkID) []Chunk

func (*P2PFile) UpdateData ¶

func (f *P2PFile) UpdateData()

TODO:

type P2PFileStorage ¶

type P2PFileStorage struct {
	Haves    map[PeerID][]ChunkID
	FileSize int
}

type P2PRemoteStorage ¶

type P2PRemoteStorage map[string]P2PFileStorage

func NewP2PRemoteStorage ¶

func NewP2PRemoteStorage() *P2PRemoteStorage

func (P2PRemoteStorage) AddFileChunksForPeer ¶

func (s P2PRemoteStorage) AddFileChunksForPeer(peer PeerID, hash FileID, chunkIDS []ChunkID, FileSize int) error

func (P2PRemoteStorage) GetFileSize ¶

func (s P2PRemoteStorage) GetFileSize(hash FileID) (int, error)

func (P2PRemoteStorage) GetPeersFileChunks ¶

func (s P2PRemoteStorage) GetPeersFileChunks(hash FileID) (map[PeerID][]ChunkID, error)

type P2PStorage ¶

type P2PStorage struct {
	// Map in not thread safe by design, so we have to use a mutex
	sync.Mutex
	Config     LocalStorageConfig
	LocalFiles map[string]P2PFile
}

func (*P2PStorage) AddFile ¶

func (s *P2PStorage) AddFile(fileData []byte) (FileID, error)

AddFile Add a file to local storage. Return the hashed file when successfull

func (*P2PStorage) AddReceivedFileChunks ¶

func (s *P2PStorage) AddReceivedFileChunks(hash FileID, chunks []Chunk) error