Utility class to fetch latest version of the segmented data. More...

#include <segment-fetcher.hpp>

Inheritance diagram for ndn::util::SegmentFetcher:

Collaboration diagram for ndn::util::SegmentFetcher:

Public Types
enum	ErrorCode { INTEREST_TIMEOUT = 1, DATA_HAS_NO_SEGMENT = 2, SEGMENT_VALIDATION_FAIL = 3, NACK_ERROR = 4 }
	Error codes that can be passed to ErrorCallback. More...

typedef function< void(const ConstBufferPtr &data)>	CompleteCallback

typedef function< void(uint32_t code, const std::string &msg)>	ErrorCallback

Static Public Member Functions
static shared_ptr< SegmentFetcher >	fetch (Face &face, const Interest &baseInterest, security::v2::Validator &validator, const CompleteCallback &completeCallback, const ErrorCallback &errorCallback)
	Initiates segment fetching. More...

static shared_ptr< SegmentFetcher >	fetch (Face &face, const Interest &baseInterest, shared_ptr< security::v2::Validator > validator, const CompleteCallback &completeCallback, const ErrorCallback &errorCallback)
	Initiate segment fetching. More...

Public Attributes
Signal< SegmentFetcher, Data >	afterSegmentReceived
	Emits whenever a data segment received. More...

Signal< SegmentFetcher, Data >	afterSegmentValidated
	Emits whenever a received data segment has been successfully validated. More...

Static Public Attributes
static const uint32_t	MAX_INTEREST_REEXPRESS = 3
	Maximum number of times an interest will be reexpressed incase of NackCallback. More...

Detailed Description

Utility class to fetch latest version of the segmented data.

SegmentFetcher assumes that the data is named /<prefix>/<version>/<segment>, where:

<prefix> is the specified prefix,
<version> is an unknown version that needs to be discovered, and
<segment> is a segment number (number of segments is unknown and is controlled by FinalBlockId field in at least the last Data packet

The following logic is implemented in SegmentFetcher:

Express first interest to discover version:

Interest: /<prefix>?ChildSelector=1&MustBeFresh=yes

Infer the latest version of Data: <version> = Data.getName().get(-2)
If segment number in the retrieved packet == 0, go to step 5.
Send Interest for segment 0:

Interest: /<prefix>/<version>/<segment=0>

Keep sending Interests for the next segment while the retrieved Data does not have FinalBlockId or FinalBlockId != Data.getName().get(-1).

Interest: /<prefix>/<version>/<segment=(N+1))>

Fire onCompletion callback with memory block that combines content part from all segmented objects.

If an error occurs during the fetching process, an error callback is fired with a proper error code. The following errors are possible:

INTEREST_TIMEOUT: if any of the Interests times out
DATA_HAS_NO_SEGMENT: if any of the retrieved Data packets don't have segment as a last component of the name (not counting implicit digest)
SEGMENT_VALIDATION_FAIL: if any retrieved segment fails user-provided validation

In order to validate individual segments, a Validator instance needs to be specified. If the segment validation is successful, afterValidationSuccess callback is fired, otherwise afterValidationFailure callback.

Examples:

void
afterFetchComplete(const ConstBufferPtr& data)
{
  ...
}

void
afterFetchError(uint32_t errorCode, const std::string& errorMsg)
{
  ...
}

...
SegmentFetcher::fetch(face, Interest("/data/prefix", 30_s),
                      validator,
                      bind(&afterFetchComplete, this, _1),
                      bind(&afterFetchError, this, _1, _2));

Definition at line 102 of file segment-fetcher.hpp.

Member Typedef Documentation

◆ CompleteCallback

typedef function<void (const ConstBufferPtr& data)> ndn::util::SegmentFetcher::CompleteCallback

Definition at line 110 of file segment-fetcher.hpp.

◆ ErrorCallback

typedef function<void (uint32_t code, const std::string& msg)> ndn::util::SegmentFetcher::ErrorCallback

Definition at line 111 of file segment-fetcher.hpp.

Member Enumeration Documentation

◆ ErrorCode

enum ndn::util::SegmentFetcher::ErrorCode

Error codes that can be passed to ErrorCallback.

Enumerator
INTEREST_TIMEOUT
DATA_HAS_NO_SEGMENT
SEGMENT_VALIDATION_FAIL
NACK_ERROR

Definition at line 116 of file segment-fetcher.hpp.

Member Function Documentation

◆ fetch() [1/2]

shared_ptr< SegmentFetcher > ndn::util::SegmentFetcher::fetch	(	Face &	face,
		const Interest &	baseInterest,
		security::v2::Validator &	validator,
		const CompleteCallback &	completeCallback,
		const ErrorCallback &	errorCallback
	)

static

Initiates segment fetching.

Parameters

face	Reference to the Face that should be used to fetch data
baseInterest	An Interest for the initial segment of requested data. This interest may include custom InterestLifetime and selectors that will propagate to all subsequent Interests. The only exception is that the initial Interest will be forced to include "ChildSelector=rightmost" and "MustBeFresh=true" selectors, which will be turned off in subsequent Interests.
validator	Reference to the Validator that should be used to validate data. Caller must ensure validator is valid until either completeCallback or errorCallback is invoked.
completeCallback	Callback to be fired when all segments are fetched
errorCallback	Callback to be fired when an error occurs (

See also: Errors)

Returns: A shared_ptr to the constructed SegmentFetcher

Definition at line 50 of file segment-fetcher.cpp.

◆ fetch() [2/2]

shared_ptr< SegmentFetcher > ndn::util::SegmentFetcher::fetch	(	Face &	face,
		const Interest &	baseInterest,
		shared_ptr< security::v2::Validator >	validator,
		const CompleteCallback &	completeCallback,
		const ErrorCallback &	errorCallback
	)

static

Initiate segment fetching.

Parameters

face	Reference to the Face that should be used to fetch data
baseInterest	An Interest for the initial segment of requested data. This interest may include custom InterestLifetime and selectors that will propagate to all subsequent Interests. The only exception is that the initial Interest will be forced to include "ChildSelector=1" and "MustBeFresh=true" selectors, which will be turned off in subsequent Interests.
validator	A shared_ptr to the Validator that should be used to validate data.
completeCallback	Callback to be fired when all segments are fetched
errorCallback	Callback to be fired when an error occurs (

See also: Errors)

Returns: A shared_ptr to the constructed SegmentFetcher

Definition at line 61 of file segment-fetcher.cpp.

Member Data Documentation

◆ MAX_INTEREST_REEXPRESS

const uint32_t ndn::util::SegmentFetcher::MAX_INTEREST_REEXPRESS = 3

static

Maximum number of times an interest will be reexpressed incase of NackCallback.

Definition at line 108 of file segment-fetcher.hpp.

◆ afterSegmentReceived

Signal<SegmentFetcher, Data> ndn::util::SegmentFetcher::afterSegmentReceived

Emits whenever a data segment received.

Definition at line 211 of file segment-fetcher.hpp.

◆ afterSegmentValidated

Signal<SegmentFetcher, Data> ndn::util::SegmentFetcher::afterSegmentValidated

Emits whenever a received data segment has been successfully validated.

Definition at line 216 of file segment-fetcher.hpp.

The documentation for this class was generated from the following files:

ndnSIM/ndn-cxx/src/util/segment-fetcher.hpp
ndnSIM/ndn-cxx/src/util/segment-fetcher.cpp

Public Types

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ CompleteCallback

◆ ErrorCallback

Member Enumeration Documentation

◆ ErrorCode

Member Function Documentation

◆ fetch() [1/2]

◆ fetch() [2/2]

Member Data Documentation

◆ MAX_INTEREST_REEXPRESS

◆ afterSegmentReceived

◆ afterSegmentValidated