Ditto 1.1.3
PendingCollectionsOperation.hpp
1#ifndef _DITTO_PENDING_COLLECTIONS_OPERATION_
2#define _DITTO_PENDING_COLLECTIONS_OPERATION_
3
4#include "Collection.hpp"
5#include "CollectionsEvent.hpp"
6#include "LiveQuery.hpp"
7#include "PendingCursorOperation.hpp"
8#include "SortDirection.hpp"
9#include "Subscription.hpp"
10
11#include <functional>
12#include <memory>
13#include <string>
14#include <vector>
15
16namespace ditto {
17class DittoHandleWrapper;
18
20 std::function<void(CollectionsEvent)> fn;
21};
22
24 std::function<void(CollectionsEvent, std::function<void()> &)> fn;
25};
26
54 friend class Store;
55
56 std::shared_ptr<DittoHandleWrapper> ditto_handle_wrapper;
57 uint64_t site_id;
58 PendingCursorOperation pending_cursor_operation;
59
61 std::shared_ptr<DittoHandleWrapper> ditto_handle_wrapper,
62 uint64_t site_id);
63
64public:
66
75
90
101 PendingCollectionsOperation &sort(std::string query, SortDirection direction);
102
109 std::vector<Collection> exec() const;
110
122 Subscription subscribe() const;
123
137 std::shared_ptr<LiveQuery> observe(CollectionsEventHandler handler) const;
138
151 std::shared_ptr<LiveQuery>
153
168 std::shared_ptr<LiveQuery>
170
184 std::shared_ptr<LiveQuery> observe_local_with_next_signal(
186};
187} // namespace ditto
188#endif
Provides information about the changes that have occurred in relation to an event delivered when obse...
Definition: CollectionsEvent.hpp:21
These objects are returned when calling collections() on Store objects.
Definition: PendingCollectionsOperation.hpp:53
std::shared_ptr< LiveQuery > observe_local_with_next_signal(CollectionsEventWithNextSignalHandler handler) const
Enables you to listen for changes that occur in relation to the collections that are known about loca...
Definition: PendingCollectionsOperation.cpp:68
PendingCollectionsOperation & sort(std::string query, SortDirection direction)
Sort the collections based on a property of the collection.
Definition: PendingCollectionsOperation.cpp:96
std::vector< Collection > exec() const
Return the list of collections requested based on the preceding function chaining.
Definition: PendingCollectionsOperation.cpp:19
std::shared_ptr< LiveQuery > observe_local(CollectionsEventHandler handler) const
Enables you to listen for changes that occur in relation to the collections that are known about loca...
Definition: PendingCollectionsOperation.cpp:38
std::shared_ptr< LiveQuery > observe(CollectionsEventHandler handler) const
Enables you to listen for changes that occur in relation to the collections that are known about....
Definition: PendingCollectionsOperation.cpp:26
PendingCollectionsOperation & offset(uint32_t offset)
Offset the resulting set of collections.
Definition: PendingCollectionsOperation.cpp:84
PendingCollectionsOperation & limit(uint32_t limit)
Limit the number of collections that get returned.
Definition: PendingCollectionsOperation.cpp:90
Subscription subscribe() const
Subscribes the device to updates about collections that other devices know about.
Definition: PendingCollectionsOperation.cpp:102
std::shared_ptr< LiveQuery > observe_with_next_signal(CollectionsEventWithNextSignalHandler handler) const
Enables you to listen for changes that occur in relation to the collections that are known about....
Definition: PendingCollectionsOperation.cpp:52
These objects are returned when using find-like functionality on Collection objects.
Definition: PendingCursorOperation.hpp:49
Provides access to Collections and a write transaction API.
Definition: Store.hpp:20
While Subscription objects remain in scope they ensure that documents in the collection specified,...
Definition: Subscription.hpp:17
Definition: PendingCollectionsOperation.hpp:19
Definition: PendingCollectionsOperation.hpp:23