All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Public Member Functions | List of all members
ndn::ChronoSync2013::SyncState Class Reference

A SyncState holds the values of a sync state message which is passed to the onReceivedSyncState callback which was given to the ChronoSyn2013 constructor. More...

#include <chrono-sync2013.hpp>

Public Member Functions

 SyncState (const std::string &dataPrefixUri, int sessionNo, int sequenceNo, const Blob &applicationInfo)
 
const std::string & getDataPrefix () const
 Get the application data prefix. More...
 
int getSessionNo () const
 Get the session number associated with the application data prefix. More...
 
int getSequenceNo () const
 Get the sequence number for this sync state message. More...
 
const BlobgetApplicationInfo () const
 Get the application info which was included when the sender published the next sequence number. More...
 

Detailed Description

A SyncState holds the values of a sync state message which is passed to the onReceivedSyncState callback which was given to the ChronoSyn2013 constructor.

Note: this has the same info as the Protobuf class Sync::SyncState, but we make a separate class so that we don't need the Protobuf definition in the ChronoSync API.

Member Function Documentation

const Blob& ndn::ChronoSync2013::SyncState::getApplicationInfo ( ) const
inline

Get the application info which was included when the sender published the next sequence number.

Returns
The applicationInfo Blob. If the sender did not provide any, return an isNull Blob.
const std::string& ndn::ChronoSync2013::SyncState::getDataPrefix ( ) const
inline

Get the application data prefix.

Returns
The application data prefix as a Name URI string.
int ndn::ChronoSync2013::SyncState::getSequenceNo ( ) const
inline

Get the sequence number for this sync state message.

Returns
The sequence number.
int ndn::ChronoSync2013::SyncState::getSessionNo ( ) const
inline

Get the session number associated with the application data prefix.

Returns
The session number.

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