java.nio.channels
Interface WritableByteChannel

All Superinterfaces:
Channel sample code for java.nio.channels.Channel definition code for java.nio.channels.Channel , Closeable sample code for java.io.Closeable definition code for java.io.Closeable
All Known Subinterfaces:
ByteChannel sample code for java.nio.channels.ByteChannel definition code for java.nio.channels.ByteChannel , GatheringByteChannel sample code for java.nio.channels.GatheringByteChannel definition code for java.nio.channels.GatheringByteChannel
All Known Implementing Classes:
DatagramChannel sample code for java.nio.channels.DatagramChannel definition code for java.nio.channels.DatagramChannel , FileChannel sample code for java.nio.channels.FileChannel definition code for java.nio.channels.FileChannel , Pipe.SinkChannel sample code for java.nio.channels.Pipe.SinkChannel definition code for java.nio.channels.Pipe.SinkChannel , SocketChannel sample code for java.nio.channels.SocketChannel definition code for java.nio.channels.SocketChannel

public interface WritableByteChannel
extends Channel sample code for java.nio.channels.Channel definition code for java.nio.channels.Channel

A channel that can write bytes.

Only one write operation upon a writable channel may be in progress at any given time. If one thread initiates a write operation upon a channel then any other thread that attempts to initiate another write operation will block until the first operation is complete. Whether or not other kinds of I/O operations may proceed concurrently with a write operation depends upon the type of the channel.

Since:
1.4

Method Summary
 int write sample code for java.nio.channels.WritableByteChannel.write(java.nio.ByteBuffer) definition code for java.nio.channels.WritableByteChannel.write(java.nio.ByteBuffer) (ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer  src)
          Writes a sequence of bytes to this channel from the given buffer.
 
Methods inherited from interface java.nio.channels.Channel sample code for java.nio.channels.Channel definition code for java.nio.channels.Channel
close sample code for java.nio.channels.Channel.close() definition code for java.nio.channels.Channel.close() , isOpen sample code for java.nio.channels.Channel.isOpen() definition code for java.nio.channels.Channel.isOpen()
 

Method Detail

write sample code for java.nio.channels.WritableByteChannel.write(java.nio.ByteBuffer) definition code for java.nio.channels.WritableByteChannel.write(java.nio.ByteBuffer)

int write(ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer  src)
          throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Writes a sequence of bytes to this channel from the given buffer.

An attempt is made to write up to r bytes to the channel, where r is the number of bytes remaining in the buffer, that is, dst.remaining(), at the moment this method is invoked.

Suppose that a byte sequence of length n is written, where 0 <= n <= r. This byte sequence will be transferred from the buffer starting at index p, where p is the buffer's position at the moment this method is invoked; the index of the last byte written will be p + n - 1. Upon return the buffer's position will be equal to p + n; its limit will not have changed.

Unless otherwise specified, a write operation will return only after writing all of the r requested bytes. Some types of channels, depending upon their state, may write only some of the bytes or possibly none at all. A socket channel in non-blocking mode, for example, cannot write any more bytes than are free in the socket's output buffer.

This method may be invoked at any time. If another thread has already initiated a write operation upon this channel, however, then an invocation of this method will block until the first operation is complete.

Parameters:
src - The buffer from which bytes are to be retrieved
Returns:
The number of bytes written, possibly zero
Throws:
NonWritableChannelException sample code for java.nio.channels.NonWritableChannelException definition code for java.nio.channels.NonWritableChannelException - If this channel was not opened for writing
ClosedChannelException sample code for java.nio.channels.ClosedChannelException definition code for java.nio.channels.ClosedChannelException - If this channel is closed
AsynchronousCloseException sample code for java.nio.channels.AsynchronousCloseException definition code for java.nio.channels.AsynchronousCloseException - If another thread closes this channel while the write operation is in progress
ClosedByInterruptException sample code for java.nio.channels.ClosedByInterruptException definition code for java.nio.channels.ClosedByInterruptException - If another thread interrupts the current thread while the write operation is in progress, thereby closing the channel and setting the current thread's interrupt status
IOException sample code for java.io.IOException definition code for java.io.IOException - If some other I/O error occurs