com.eightkdata.mongowp.messages.request.BsonContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mongowp-core Show documentation

There is a newer version: 0.50.0

/*
 * This file is part of MongoWP.
 *
 * MongoWP is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * MongoWP is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with mongo-server-core. If not, see .
 *
 * Copyright (C) 2016 8Kdata.
 * 
 */

package com.eightkdata.mongowp.messages.request;

import javax.annotation.concurrent.NotThreadSafe;

/**
 * This class represents a callback to clean up all BSON data that could be
 * offheap.
 *
 * Some implementations could decide to not store documents (or part of them)
 * on the heap. In that case, they have to supply an instance of this class.
 *
 * All documents referenced on a request must be alive at least until
 * this callback is called.
 */
@NotThreadSafe
public interface BsonContext extends AutoCloseable {

    /**
     * @return true if documents associated with this context are still valid.
     */
    boolean isValid();

}