# GatheringByteChannel

public interface **GatheringByteChannel** implements [WritableByteChannel](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/WritableByteChannel.html)

|---|---|---|
| Known Indirect Subclasses [DatagramChannel](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/DatagramChannel.html), [FileChannel](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/FileChannel.html), [Pipe.SinkChannel](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/Pipe.SinkChannel.html), [SocketChannel](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/SocketChannel.html) |---|---| | [DatagramChannel](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/DatagramChannel.html) | A selectable channel for datagram-oriented sockets. | | [FileChannel](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/FileChannel.html) | A channel for reading, writing, mapping, and manipulating a file. | | [Pipe.SinkChannel](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/Pipe.SinkChannel.html) | A channel representing the writable end of a `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/Pipe.html`. | | [SocketChannel](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/SocketChannel.html) | A selectable channel for stream-oriented connecting sockets. | |||

A channel that can write bytes from a sequence of buffers.

A *gathering* write operation writes, in a single invocation, a
sequence of bytes from one or more of a given sequence of buffers.
Gathering writes are often useful when implementing network protocols or
file formats that, for example, group data into segments consisting of one
or more fixed-length headers followed by a variable-length body. Similar
*scattering* read operations are defined in the `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/ScatteringByteChannel.html` interface.

<br />

### Public Method Summary

|---|---|
| abstract long | [write](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/GatheringByteChannel.html#write(java.nio.ByteBuffer[]))([ByteBuffer\[\]](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ByteBuffer.html) srcs) Writes a sequence of bytes to this channel from the given buffers. |
| abstract long | [write](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/GatheringByteChannel.html#write(java.nio.ByteBuffer[],%20int,%20int))([ByteBuffer\[\]](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ByteBuffer.html) srcs, int offset, int length) Writes a sequence of bytes to this channel from a subsequence of the given buffers. |

### Inherited Method Summary

From interface [java.nio.channels.WritableByteChannel](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/WritableByteChannel.html)

|---|---|
| abstract int | [write](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/WritableByteChannel.html#write(java.nio.ByteBuffer))([ByteBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ByteBuffer.html) src) Writes a sequence of bytes to this channel from the given buffer. |

From interface [java.nio.channels.Channel](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/Channel.html)

|---|---|
| abstract void | [close](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/Channel.html#close())() Closes this channel. |
| abstract boolean | [isOpen](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/Channel.html#isOpen())() Tells whether or not this channel is open. |

From interface [java.io.Closeable](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Closeable.html)

|---|---|
| abstract void | [close](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Closeable.html#close())() Closes this stream and releases any system resources associated with it. |

From interface [java.lang.AutoCloseable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/AutoCloseable.html)

|---|---|
| abstract void | [close](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/AutoCloseable.html#close())() Closes this resource, relinquishing any underlying resources. |

## Public Methods

#### public abstract long
**write**
([ByteBuffer\[\]](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ByteBuffer.html) srcs)

Writes a sequence of bytes to this channel from the given buffers.

An invocation of this method of the form c.write(srcs)
behaves in exactly the same manner as the invocation

> ```
>  c.write(srcs, 0, srcs.length);
> ```

<br />

##### Parameters

| srcs | The buffers from which bytes are to be retrieved |
|---|---|

##### Returns

- The number of bytes written, possibly zero

##### Throws

| [NonWritableChannelException](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/NonWritableChannelException.html) | If this channel was not opened for writing |
| [ClosedChannelException](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/ClosedChannelException.html) | If this channel is closed |
| [AsynchronousCloseException](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/AsynchronousCloseException.html) | If another thread closes this channel while the write operation is in progress |
| [ClosedByInterruptException](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/ClosedByInterruptException.html) | 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](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) | If some other I/O error occurs |
|---|---|

#### public abstract long
**write**
([ByteBuffer\[\]](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ByteBuffer.html) srcs, int offset, int length)

Writes a sequence of bytes to this channel from a subsequence of the
given buffers.

An attempt is made to write up to *r* bytes to this channel,
where *r* is the total number of bytes remaining in the specified
subsequence of the given buffer array, that is,

> ```
>  srcs[offset].remaining()
>      + srcs[offset+1].remaining()
>      + ... + srcs[offset+length-1].remaining()
> ```
at the moment that this method is invoked.

Suppose that a byte sequence of length *n* is written, where
0 \<= *n* \<= *r*.
Up to the first srcs\[offset\].remaining() bytes of this sequence
are written from buffer srcs\[offset\], up to the next
srcs\[offset+1\].remaining() bytes are written from buffer
srcs\[offset+1\], and so forth, until the entire byte sequence is
written. As many bytes as possible are written from each buffer, hence
the final position of each updated buffer, except the last updated
buffer, is guaranteed to be equal to that buffer's limit.

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.

<br />

##### Parameters

| srcs | The buffers from which bytes are to be retrieved |
| offset | The offset within the buffer array of the first buffer from which bytes are to be retrieved; must be non-negative and no larger than srcs.length |
| length | The maximum number of buffers to be accessed; must be non-negative and no larger than srcs.length - offset |
|---|---|

##### Returns

- The number of bytes written, possibly zero

##### Throws

| [IndexOutOfBoundsException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IndexOutOfBoundsException.html) | If the preconditions on the offset and length parameters do not hold |
| [NonWritableChannelException](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/NonWritableChannelException.html) | If this channel was not opened for writing |
| [ClosedChannelException](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/ClosedChannelException.html) | If this channel is closed |
| [AsynchronousCloseException](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/AsynchronousCloseException.html) | If another thread closes this channel while the write operation is in progress |
| [ClosedByInterruptException](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/ClosedByInterruptException.html) | 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](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) | If some other I/O error occurs |
|---|---|