IGatheringByteChannel.Write Method

Definition

Overloads

Write(ByteBuffer[])

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

Write(ByteBuffer[], Int32, Int32)

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

Write(ByteBuffer[])

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

[Android.Runtime.Register("write", "([Ljava/nio/ByteBuffer;)J", "GetWrite_arrayLjava_nio_ByteBuffer_Handler:Java.Nio.Channels.IGatheringByteChannelInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]
public long Write (Java.Nio.ByteBuffer[]? srcs);
[<Android.Runtime.Register("write", "([Ljava/nio/ByteBuffer;)J", "GetWrite_arrayLjava_nio_ByteBuffer_Handler:Java.Nio.Channels.IGatheringByteChannelInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")>]
abstract member Write : Java.Nio.ByteBuffer[] -> int64

Parameters

srcs
ByteBuffer[]

The buffers from which bytes are to be retrieved

Returns

The number of bytes written, possibly zero

Attributes

Exceptions

if the channel is closed by another thread during this write operation.

if another thread interrupts the calling thread while the operation is in progress. The interrupt state of the calling thread is set and the channel is closed.

if the channel is closed.

if offset or length , or if offset + length is greater than the size of buffers.

if another I/O error occurs; details are in the message.

if the channel has not been opened in a mode that permits writing.

Remarks

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

<blockquote>

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

</blockquote>

Java documentation for java.nio.channels.GatheringByteChannel.write(java.nio.ByteBuffer[]).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to

Write(ByteBuffer[], Int32, Int32)

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

[Android.Runtime.Register("write", "([Ljava/nio/ByteBuffer;II)J", "GetWrite_arrayLjava_nio_ByteBuffer_IIHandler:Java.Nio.Channels.IGatheringByteChannelInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]
public long Write (Java.Nio.ByteBuffer[]? srcs, int offset, int length);
[<Android.Runtime.Register("write", "([Ljava/nio/ByteBuffer;II)J", "GetWrite_arrayLjava_nio_ByteBuffer_IIHandler:Java.Nio.Channels.IGatheringByteChannelInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")>]
abstract member Write : Java.Nio.ByteBuffer[] * int * int -> int64

Parameters

srcs
ByteBuffer[]

The buffers from which bytes are to be retrieved

offset
Int32

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
Int32

The maximum number of buffers to be accessed; must be non-negative and no larger than srcs.length&nbsp;-&nbsp;offset

Returns

The number of bytes written, possibly zero

Attributes

Exceptions

if the channel is closed by another thread during this write operation.

if another thread interrupts the calling thread while the operation is in progress. The interrupt state of the calling thread is set and the channel is closed.

if the channel is closed.

if offset or length , or if offset + length is greater than the size of buffers.

if another I/O error occurs; details are in the message.

if the channel was not opened for writing.

Remarks

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,

<blockquote>

srcs[offset].remaining()
                + srcs[offset+1].remaining()
                + ... + srcs[offset+length-1].remaining()

</blockquote>

at the moment that this method is invoked.

Suppose that a byte sequence of length n is written, where 0&nbsp;<=&nbsp;n&nbsp;<=&nbsp;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.

Java documentation for java.nio.channels.GatheringByteChannel.write(java.nio.ByteBuffer[], int, int).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to