uploader.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 <cstddef>
#include <cstdint>
#include <memory>
 
#include <mongocxx/gridfs/bucket-fwd.hpp>
#include <mongocxx/gridfs/uploader-fwd.hpp>
 
#include <bsoncxx/document/value.hpp>
#include <bsoncxx/stdx/optional.hpp>
#include <bsoncxx/stdx/string_view.hpp>
#include <bsoncxx/types/bson_value/view.hpp>
#include <bsoncxx/view_or_value.hpp>
 
#include <mongocxx/client_session.hpp>
#include <mongocxx/collection.hpp>
#include <mongocxx/result/gridfs/upload.hpp>
#include <mongocxx/stdx.hpp>
 
#include <mongocxx/config/prelude.hpp>
 
namespace mongocxx {
namespace v_noabi {
namespace gridfs {
 
class uploader {
   public:
    MONGOCXX_ABI_EXPORT_CDECL() uploader() noexcept;
 
    MONGOCXX_ABI_EXPORT_CDECL() uploader(uploader&&) noexcept;
 
    MONGOCXX_ABI_EXPORT_CDECL(uploader&) operator=(uploader&&) noexcept;
 
    uploader(const uploader&) = delete;
 
    uploader& operator=(const uploader&) = delete;
 
    MONGOCXX_ABI_EXPORT_CDECL() ~uploader();
 
    explicit MONGOCXX_ABI_EXPORT_CDECL() operator bool() const noexcept;
 
    MONGOCXX_ABI_EXPORT_CDECL(void) write(const std::uint8_t* bytes, std::size_t length);
 
    MONGOCXX_ABI_EXPORT_CDECL(result::gridfs::upload) close();
 
    MONGOCXX_ABI_EXPORT_CDECL(void) abort();
 
    MONGOCXX_ABI_EXPORT_CDECL(std::int32_t) chunk_size() const;
 
   private:
    friend ::mongocxx::v_noabi::gridfs::bucket;
 
    //
    // Constructs a new uploader stream.
    //
    // @param session
    //   The client session to use for upload operations.
    //
    // @param id
    //   The id of the GridFS file being uploaded.
    //
    // @param files
    //   The files collection of the bucket receiving the file.
    //
    // @param chunks
    //   The chunks collection of the bucket receiving the file.
    //
    // @param chunk_size
    //   The size in bytes of the chunks being uploaded.
    //
    // @param metadata
    //   Optional metadata field of the files collection document.
    //
    uploader(const client_session* session,
             bsoncxx::v_noabi::types::bson_value::view id,
             stdx::string_view filename,
             collection files,
             collection chunks,
             std::int32_t chunk_size,
             stdx::optional<bsoncxx::v_noabi::document::view_or_value> metadata = {});
 
    void finish_chunk();
    void flush_chunks();
 
    class impl;
 
    impl& _get_impl();
    const impl& _get_impl() const;
 
    std::unique_ptr<impl> _impl;
};
 
}  // namespace gridfs
}  // namespace v_noabi
}  // namespace mongocxx
 
// CXX-2770: missing include of postlude header.
#if defined(MONGOCXX_TEST_MACRO_GUARDS_FIX_MISSING_POSTLUDE)
#include <mongocxx/config/postlude.hpp>
#endif