org.neo4j.io.fs

Interface StoreChannel

All Superinterfaces:

AutoCloseable, ByteChannel, Channel, Closeable, Flushable, GatheringByteChannel, InterruptibleChannel, ReadableByteChannel, ScatteringByteChannel, SeekableByteChannel, WritableByteChannel

All Known Implementing Classes:

AbstractStoreChannel, StoreFileChannel

public interface StoreChannel
extends Flushable, SeekableByteChannel, GatheringByteChannel, ScatteringByteChannel, InterruptibleChannel

Method Summary

Modifier and Type	Method and Description
void	force(boolean metaData)
StoreChannel	position(long newPosition)
int	read(ByteBuffer dst, long position)
StoreChannel	truncate(long size)
FileLock	tryLock() Attempts to acquire an exclusive lock on this channel's file.
int	write(ByteBuffer src, long position) NOTE: If you want to write bytes to disk, use #writeAll(), this does not guarantee all bytes will be written, and you are responsible for handling the return value of this call (which tells you how many bytes were written).
void	writeAll(ByteBuffer src) Same as #write(), except this method will write the full contents of the buffer in chunks if the OS fails to write it all at once.
void	writeAll(ByteBuffer src, long position) Same as #write(), except this method will write the full contents of the buffer in chunks if the OS fails to write it all at once.

Methods inherited from interface java.io.Flushable

flush

Methods inherited from interface java.nio.channels.SeekableByteChannel

position, read, size, write

Methods inherited from interface java.nio.channels.Channel

close, isOpen

Methods inherited from interface java.nio.channels.GatheringByteChannel

write, write

Methods inherited from interface java.nio.channels.ScatteringByteChannel

read, read

Methods inherited from interface java.nio.channels.InterruptibleChannel

close

Method Detail

tryLock

FileLock tryLock()
          throws IOException

Attempts to acquire an exclusive lock on this channel's file.

Returns:

A lock object representing the newly-acquired lock, or null if the lock could not be acquired.

Throws:

IOException - If an I/O error occurs.

ClosedChannelException - if the channel is closed.

write

int write(ByteBuffer src,
          long position)
   throws IOException

NOTE: If you want to write bytes to disk, use #writeAll(), this does not guarantee all bytes will be written, and you are responsible for handling the return value of this call (which tells you how many bytes were written).

Throws:

IOException

writeAll

void writeAll(ByteBuffer src,
              long position)
       throws IOException

Same as #write(), except this method will write the full contents of the buffer in chunks if the OS fails to write it all at once.

Throws:

IOException

writeAll

void writeAll(ByteBuffer src)
       throws IOException

Same as #write(), except this method will write the full contents of the buffer in chunks if the OS fails to write it all at once.

Throws:

IOException

read

int read(ByteBuffer dst,
         long position)
  throws IOException

Throws:

IOException

See Also:

FileChannel.read(java.nio.ByteBuffer, long)

force

void force(boolean metaData)
    throws IOException

Throws:

IOException

position

StoreChannel position(long newPosition)
               throws IOException

Specified by:

position in interface SeekableByteChannel

Throws:

IOException

truncate

StoreChannel truncate(long size)
               throws IOException

Specified by:

truncate in interface SeekableByteChannel

Throws:

IOException