psync::IBLT Class Reference

Invertible Bloom Lookup Table (Invertible Bloom Filter) More...

#include <iblt.hpp>

Classes
class	Error

Public Member Functions
	IBLT (size_t expectedNumEntries, CompressionScheme scheme=CompressionScheme::ZLIB)
	constructor More...
void	appendToName (ndn::Name &name) const
	Appends self to name. More...
void	erase (uint32_t key)
std::vector< uint32_t >	extractValueFromName (const ndn::name::Component &ibltName) const
	Extracts IBLT from name component. More...
const std::vector< HashTableEntry > &	getHashTable () const
void	initialize (const ndn::name::Component &ibltName)
	Populate the hash table using the vector representation of IBLT. More...
void	insert (uint32_t key)
bool	listEntries (std::set< uint32_t > &positive, std::set< uint32_t > &negative) const
	List all the entries in the IBLT. More...
IBLT	operator- (const IBLT &other) const

Detailed Description

Invertible Bloom Lookup Table (Invertible Bloom Filter)

Used by Partial Sync (PartialProducer) and Full Sync (Full Producer)

Definition at line 82 of file iblt.hpp.

Constructor & Destructor Documentation

IBLT()

psync::IBLT::IBLT ( size_t  expectedNumEntries, CompressionScheme  scheme = CompressionScheme::ZLIB  )

explicit

constructor

Parameters

expectedNumEntries	the expected number of entries in the IBLT
scheme	compression scheme to be used for the IBLT

Definition at line 70 of file iblt.cpp.

Member Function Documentation

appendToName()

void psync::IBLT::appendToName

(

ndn::Name &

name

)

const

Appends self to name.

Encodes our hash table from uint32_t vector to uint8_t vector We create a uin8_t vector 12 times the size of uint32_t vector We put the first count in first 4 cells, keySum in next 4, and keyCheck in next 4. Repeat for all the other cells of the hash table. Then we append this uint8_t vector to the name.

Parameters

name

Definition at line 222 of file iblt.cpp.

erase()

void psync::IBLT::erase

(

uint32_t

key

)

Definition at line 125 of file iblt.cpp.

extractValueFromName()

std::vector< uint32_t > psync::IBLT::extractValueFromName

(

const ndn::name::Component &

ibltName

)

const

Extracts IBLT from name component.

Converts the name into a uint8_t vector which is then decoded to a a uint32_t vector.

Parameters

ibltName

IBLT represented as a Name Component

Returns

a uint32_t vector representing the hash table of the IBLT

Definition at line 259 of file iblt.cpp.

getHashTable()

const std::vector<HashTableEntry>& psync::IBLT::getHashTable ( ) const

inline

Definition at line 133 of file iblt.hpp.

initialize()

void psync::IBLT::initialize

(

const ndn::name::Component &

ibltName

)

Populate the hash table using the vector representation of IBLT.

Parameters

ibltName

the Component representation of IBLT

Exceptions

Error

if size of values is not compatible with this IBF

Definition at line 85 of file iblt.cpp.

insert()

void psync::IBLT::insert

(

uint32_t

key

)

Definition at line 119 of file iblt.cpp.

listEntries()

bool psync::IBLT::listEntries	(	std::set< uint32_t > &	positive,
		std::set< uint32_t > &	negative
	)		const

List all the entries in the IBLT.

This is called on a difference of two IBLTs: ownIBLT - rcvdIBLT Entries listed in positive are in ownIBLT but not in rcvdIBLT Entries listed in negative are in rcvdIBLT but not in ownIBLT

Parameters

positive
negative

Returns

true if decoding is complete successfully

Definition at line 131 of file iblt.cpp.

operator-()

IBLT psync::IBLT::operator-

(

const IBLT &

other

)

const

Definition at line 164 of file iblt.cpp.