Ditto 4.6.0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
ditto::SyncSubscription Class Reference

A sync subscription configures Ditto to receive updates from remote peers about documents matching the subscription's query. More...

#include <SyncSubscription.hpp>

Inheritance diagram for ditto::SyncSubscription:
ditto::Observer

Public Member Functions

void cancel ()
 Cancels the sync subscription so that new changes matching the query are no longer received from other peers. No-op if it's already cancelled via or the owning Ditto object goes out of scope.
 
bool is_cancelled ()
 

Detailed Description

A sync subscription configures Ditto to receive updates from remote peers about documents matching the subscription's query.

Member Function Documentation

◆ is_cancelled()

bool ditto::SyncSubscription::is_cancelled ( )

Convenience property, returns true if the sync subscription has been cancelled, otherwise returns false. Also, a sync subscription is considered cancelled if the owning Ditto object goes out of scope.