4.8.0-rc.2/api-reference/_live_query_event_8hpp_source.html

#ifndef _DITTO_LIVE_QUERY_EVENT_

#define _DITTO_LIVE_QUERY_EVENT_


#include "Document.hpp"

#include "LiveQueryMove.hpp"


#include <cstddef>

#include <vector>


namespace ditto {


class LiveQueryEvent {

  friend class LiveQuery;


  LiveQueryEvent();

  LiveQueryEvent(std::vector<Document> old_documents,

                 std::vector<std::size_t> insertions,

                 std::vector<std::size_t> deletions,

                 std::vector<std::size_t> updates,

                 std::vector<LiveQueryMove> moves);


public:

  bool is_initial;


  std::vector<Document> old_documents;


  std::vector<std::size_t> insertions;


  std::vector<std::size_t> deletions;


  std::vector<std::size_t> updates;


  std::vector<LiveQueryMove> moves;


  static uint64_t hash(std::vector<Document> const &documents);


  static std::string hash_mnemonic(std::vector<Document> const &documents);

};


} // namespace ditto


#endif

ditto::LiveQueryEvent
The events that you receive when dealing with live queries.
Definition LiveQueryEvent.hpp:15

ditto::LiveQueryEvent::old_documents
std::vector< Document > old_documents
A list of all of the documents that matched the live query as part of the previous update.
Definition LiveQueryEvent.hpp:39

ditto::LiveQueryEvent::hash
static uint64_t hash(std::vector< Document > const &documents)
Returns a hash that represents the set of matching documents.
Definition LiveQueryEvent.cpp:23

ditto::LiveQueryEvent::updates
std::vector< std::size_t > updates
A list of the indexes in the list of new matching documents at which already matching documents have ...
Definition LiveQueryEvent.hpp:57

ditto::LiveQueryEvent::deletions
std::vector< std::size_t > deletions
A list of the indexes in the list of old matching documents at which previously matching documents ha...
Definition LiveQueryEvent.hpp:51

ditto::LiveQueryEvent::is_initial
bool is_initial
Returns whether or not this is the initial event for the associated live query.
Definition LiveQueryEvent.hpp:33

ditto::LiveQueryEvent::hash_mnemonic
static std::string hash_mnemonic(std::vector< Document > const &documents)
Returns a pattern of words that together create a mnemonic, which represents the set of matching docu...
Definition LiveQueryEvent.cpp:28

ditto::LiveQueryEvent::moves
std::vector< LiveQueryMove > moves
A list of the move objects that provide the indexes, in relation to the list of old matching document...
Definition LiveQueryEvent.hpp:65

ditto::LiveQueryEvent::insertions
std::vector< std::size_t > insertions
A list of the indexes in the list of new matching documents at which new matching documents have been...
Definition LiveQueryEvent.hpp:45

ditto::LiveQuery
The type that is returned when calling observe_local. It handles the logic for calling the event hand...
Definition LiveQuery.hpp:103