change_stream.hpp

Go to the documentation of this file.

// Copyright 2009-present MongoDB, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
 
#pragma once
 
#include <chrono>
 
#include <mongocxx/client-fwd.hpp>
#include <mongocxx/collection-fwd.hpp>
#include <mongocxx/database-fwd.hpp>
#include <mongocxx/options/change_stream-fwd.hpp>
 
#include <bsoncxx/document/view_or_value.hpp>
#include <bsoncxx/string/view_or_value.hpp>
#include <bsoncxx/types.hpp>
#include <bsoncxx/types/bson_value/view_or_value.hpp>
 
#include <mongocxx/stdx.hpp>
 
#include <mongocxx/config/prelude.hpp>
 
namespace mongocxx {
namespace v_noabi {
namespace options {
 
class change_stream {
   public:
    MONGOCXX_ABI_EXPORT_CDECL() change_stream();
 
    MONGOCXX_ABI_EXPORT_CDECL(change_stream&)
    full_document(bsoncxx::v_noabi::string::view_or_value full_doc);
 
    MONGOCXX_ABI_EXPORT_CDECL(
        const bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::string::view_or_value>&)
    full_document() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(change_stream&)
    full_document_before_change(bsoncxx::v_noabi::string::view_or_value full_doc_before_change);
 
    MONGOCXX_ABI_EXPORT_CDECL(
        const bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::string::view_or_value>&)
    full_document_before_change() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(change_stream&) batch_size(std::int32_t batch_size);
 
    MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<std::int32_t>&) batch_size() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(change_stream&)
    comment(bsoncxx::v_noabi::types::bson_value::view_or_value comment);
 
    MONGOCXX_ABI_EXPORT_CDECL(
        const stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value>&)
    comment() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(change_stream&)
    resume_after(bsoncxx::v_noabi::document::view_or_value resume_after);
 
    MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<bsoncxx::v_noabi::document::view_or_value>&)
    resume_after() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(change_stream&)
    start_after(bsoncxx::v_noabi::document::view_or_value token);
 
    MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<bsoncxx::v_noabi::document::view_or_value>&)
    start_after() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(change_stream&)
    collation(bsoncxx::v_noabi::document::view_or_value collation);
 
    MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<bsoncxx::v_noabi::document::view_or_value>&)
    collation() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(change_stream&) max_await_time(std::chrono::milliseconds max_time);
 
    MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<std::chrono::milliseconds>&)
    max_await_time() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(change_stream&)
    start_at_operation_time(bsoncxx::v_noabi::types::b_timestamp timestamp);
 
   private:
    friend ::mongocxx::v_noabi::client;
    friend ::mongocxx::v_noabi::collection;
    friend ::mongocxx::v_noabi::database;
 
    bsoncxx::v_noabi::document::value as_bson() const;
 
    stdx::optional<bsoncxx::v_noabi::string::view_or_value> _full_document;
    stdx::optional<bsoncxx::v_noabi::string::view_or_value> _full_document_before_change;
    stdx::optional<std::int32_t> _batch_size;
    stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value> _comment;
    stdx::optional<bsoncxx::v_noabi::document::view_or_value> _collation;
    stdx::optional<bsoncxx::v_noabi::document::view_or_value> _resume_after;
    stdx::optional<bsoncxx::v_noabi::document::view_or_value> _start_after;
    stdx::optional<std::chrono::milliseconds> _max_await_time;
    // _start_at_operation_time is not wrapped in a stdx::optional because of a longstanding bug in
    // the MNMLSTC polyfill that has been fixed on master, but not in the latest release:
    // https://github.com/mnmlstc/core/pull/23
    bsoncxx::v_noabi::types::b_timestamp _start_at_operation_time = {};
    bool _start_at_operation_time_set = false;
};
 
}  // namespace options
}  // namespace v_noabi
}  // namespace mongocxx
 
#include <mongocxx/config/postlude.hpp>