Ditto  1.0.9
Static Public Member Functions | Public Attributes | List of all members
ditto::SingleDocumentLiveQueryEvent Class Reference

Provides information about a live query event relating to a single document live query. More...

Static Public Member Functions

static uint64_t hash (std::shared_ptr< Document > document)
 Returns a hash that represents the document. More...
 
static std::string hash_mnemonic (std::shared_ptr< Document > document)
 Returns a pattern of words that together create a mnemonic, which represents the document. More...
 

Public Attributes

bool is_initial
 
std::shared_ptr< Documentold_document
 

Detailed Description

Provides information about a live query event relating to a single document live query.

Member Function Documentation

◆ hash()

uint64_t ditto::SingleDocumentLiveQueryEvent::hash ( std::shared_ptr< Document document)
static

Returns a hash that represents the document.

Parameters
[in]documentthe document delivered alongside the live query event.
Returns
a hash that represents document.

◆ hash_mnemonic()

std::string ditto::SingleDocumentLiveQueryEvent::hash_mnemonic ( std::shared_ptr< Document document)
static

Returns a pattern of words that together create a mnemonic, which represents the document.

Parameters
[in]documentthe document delivered alongside the live query event.
Returns
a pattern of words that together create a mnemonic, which represents the document.

Member Data Documentation

◆ is_initial

bool ditto::SingleDocumentLiveQueryEvent::is_initial

Indicates whether or not this is the first event to be delivered for this document as part of its corresponding LiveQuery.

◆ old_document

std::shared_ptr<Document> ditto::SingleDocumentLiveQueryEvent::old_document

The representation of the document before the latest update.