c4Observer.h

Go to the documentation of this file.

//
// c4Observer.h
//
// Copyright 2016-Present Couchbase, Inc.
//
// Use of this software is governed by the Business Source License included
// in the file licenses/BSL-Couchbase.txt.  As of the Change Date specified
// in that file, in accordance with the Business Source License, use of this
// software will be governed by the Apache License, Version 2.0, included in
// the file licenses/APL2.txt.
//
 
#pragma once
 
#include "c4DocumentTypes.h"
 
C4_ASSUME_NONNULL_BEGIN
C4API_BEGIN_DECLS
 
 
typedef void (*C4CollectionObserverCallback)(C4CollectionObserver* observer, void* C4NULLABLE context);
 
 
NODISCARD CBL_CORE_API C4CollectionObserver* c4dbobs_createOnCollection(C4Collection*                collection,
                                                                        C4CollectionObserverCallback callback,
                                                                        void* C4NULLABLE             context,
                                                                        C4Error* C4NULLABLE          error) C4API;
 
NODISCARD CBL_CORE_API C4CollectionObservation c4dbobs_getChanges(C4CollectionObserver* observer,
                                                                  C4CollectionChange    outChanges[C4NONNULL],
                                                                  uint32_t              maxChanges) C4API;
 
CBL_CORE_API void c4dbobs_releaseChanges(C4CollectionChange changes[C4NONNULL], uint32_t numChanges) C4API;
 
typedef void (*C4DocumentObserverCallback)(C4DocumentObserver* observer, C4Collection* collection, C4String docID,
                                           C4SequenceNumber sequence, void* C4NULLABLE context);
 
 
NODISCARD CBL_CORE_API C4DocumentObserver* c4docobs_createWithCollection(C4Collection* collection, C4String docID,
                                                                         C4DocumentObserverCallback callback,
                                                                         void* C4NULLABLE           context,
                                                                         C4Error* C4NULLABLE        error) C4API;
 
typedef void (*C4QueryObserverCallback)(C4QueryObserver* observer, C4Query* query, void* C4NULLABLE context);
 
NODISCARD CBL_CORE_API C4QueryObserver* c4queryobs_create(C4Query* query, C4QueryObserverCallback callback,
                                                          void* C4NULLABLE context) C4API;
 
CBL_CORE_API void c4queryobs_setEnabled(C4QueryObserver* obs, bool enabled) C4API;
 
NODISCARD CBL_CORE_API C4QueryEnumerator* C4NULLABLE c4queryobs_getEnumerator(C4QueryObserver* obs, bool forget,
                                                                              C4Error* C4NULLABLE error) C4API;
 
C4API_END_DECLS
C4_ASSUME_NONNULL_END