com.mongodb.reactivestreams.client.gridfs.GridFSDownloadPublisher Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mongodb-driver-reactivestreams Show documentation

A Reactive Streams implementation of the MongoDB Java driver

There is a newer version: 5.3.0-beta0

Show newest version

/*
 * Copyright 2008-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.
 */

package com.mongodb.reactivestreams.client.gridfs;

import com.mongodb.client.gridfs.model.GridFSFile;
import org.reactivestreams.Publisher;

import java.nio.ByteBuffer;

/**
 * A GridFS Publisher for downloading data from GridFS
 *
 * Provides the {@code GridFSFile} for the file to being downloaded as well as a way to control the batchsize.
 *
 * @since 1.13
 */
public interface GridFSDownloadPublisher extends Publisher {

    /**
     * Gets the corresponding {@link GridFSFile} for the file being downloaded
     *
     * @return a Publisher with a single element, the corresponding GridFSFile for the file being downloaded
     */
    Publisher getGridFSFile();

    /**
     * The preferred number of bytes per {@code ByteBuffer} returned by the {@code Publisher}.
     *
     * Allows for larger than chunk size ByteBuffers. The actual chunk size of the data stored in MongoDB is the smallest allowable
     * {@code ByteBuffer} size.
     *
     * Can be used to control the memory consumption of this {@code Publisher}. The smaller the bufferSizeBytes the lower the memory
     * consumption and higher latency.
     *
     * Note: Must be set before the Publisher is subscribed to.
     *
     * @param bufferSizeBytes the preferred buffer size in bytes to use per {@code ByteBuffer} in the {@code Publisher}, defaults to chunk
     *                        size.
     * @return this
     */
    GridFSDownloadPublisher bufferSizeBytes(int bufferSizeBytes);
}