jetbrains.exodus.io.DataWriter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xodus-environment Show documentation

Xodus is pure Java transactional schema-less embedded database

There is a newer version: 2.0.1

/**
 * Copyright 2010 - 2018 JetBrains s.r.o.
 *
 * 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 jetbrains.exodus.io;

import jetbrains.exodus.ExodusException;

import java.io.Closeable;

public interface DataWriter extends Closeable {

    boolean isOpen();

    void write(byte[] b, int off, int len) throws ExodusException;

    void sync();

    void syncDirectory();

    @Override
    void close();

    void openOrCreateBlock(long address, long length);

    /**
     * Try to lock writer during specified time.
     *
     * @param timeout - if writer is already locked try to lock it during specified timeout.
     * @return true if locked successfully, false otherwise
     */
    boolean lock(long timeout);

    /**
     * Releases writer
     *
     * @return true if released successfully, false otherwise
     */
    boolean release();

    /**
     * For debug purposes, returns detailed information about current lock owner. Can be used if lock() failed.
     *
     * @return Human-readable information about lock owner.
     */
    String lockInfo();
}