Java Doc for GatheringByteChannel.java in  » 6.0-JDK-Core » io-nio » java » nio » channels » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Home
Java Source Code / Java Documentation
1.6.0 JDK Core
2.6.0 JDK Modules
3.6.0 JDK Modules com.sun
4.6.0 JDK Modules com.sun.java
5.6.0 JDK Modules sun
6.6.0 JDK Platform
7.Ajax
8.Apache Harmony Java SE
9.Aspect oriented
10.Authentication Authorization
11.Blogger System
12.Build
13.Byte Code
14.Cache
15.Chart
16.Chat
17.Code Analyzer
18.Collaboration
19.Content Management System
20.Database Client
21.Database DBMS
22.Database JDBC Connection Pool
23.Database ORM
24.Development
25.EJB Server
26.ERP CRM Financial
27.ESB
28.Forum
29.Game
30.GIS
31.Graphic 3D
32.Graphic Library
33.Groupware
34.HTML Parser
35.IDE
36.IDE Eclipse
37.IDE Netbeans
38.Installer
39.Internationalization Localization
40.Inversion of Control
41.Issue Tracking
42.J2EE
43.J2ME
44.JBoss
45.JMS
46.JMX
47.Library
48.Mail Clients
49.Music
50.Net
51.Parser
52.PDF
53.Portal
54.Profiler
55.Project Management
56.Report
57.RSS RDF
58.Rule Engine
59.Science
60.Scripting
61.Search Engine
62.Security
63.Sevlet Container
64.Source Control
65.Swing Library
66.Template Engine
67.Test Coverage
68.Testing
69.UML
70.Web Crawler
71.Web Framework
72.Web Mail
73.Web Server
74.Web Services
75.Web Services apache cxf 2.2.6
76.Web Services AXIS2
77.Wiki Engine
78.Workflow Engines
79.XML
80.XML UI
Java Source Code / Java Documentation » 6.0 JDK Core » io nio » java.nio.channels 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.nio.channels.GatheringByteChannel

All known Subclasses:   java.nio.channels.DatagramChannel,  java.nio.channels.SocketChannel,  java.nio.channels.FileChannel,
GatheringByteChannel
public interface GatheringByteChannel extends WritableByteChannel(Code)
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 ScatteringByteChannel interface.


author:
   Mark Reinhold
author:
   JSR-51 Expert Group
version:
   1.19, 07/05/05
since:
   1.4




Method Summary
public  longwrite(ByteBuffer[] 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()
 + ...
public  longwrite(ByteBuffer[] srcs)
     Writes a sequence of bytes to this channel from the given buffers.



Method Detail
write
public long write(ByteBuffer[] srcs, int offset, int length) throws IOException(Code)
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.


Parameters:
  srcs - The buffers from which bytes are to be retrieved
Parameters:
  offset - The offset within the buffer array of the first buffer fromwhich bytes are to be retrieved; must be non-negative and nolarger than srcs.length
Parameters:
  length - The maximum number of buffers to be accessed; must benon-negative and no larger thansrcs.length - offset The number of bytes written, possibly zero
throws:
  IndexOutOfBoundsException - If the preconditions on the offset and lengthparameters do not hold
throws:
  NonWritableChannelException - If this channel was not opened for writing
throws:
  ClosedChannelException - If this channel is closed
throws:
  AsynchronousCloseException - If another thread closes this channelwhile the write operation is in progress
throws:
  ClosedByInterruptException - If another thread interrupts the current threadwhile the write operation is in progress, therebyclosing the channel and setting the current thread'sinterrupt status
throws:
  IOException - If some other I/O error occurs



write
public long write(ByteBuffer[] srcs) throws IOException(Code)
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);

Parameters:
  srcs - The buffers from which bytes are to be retrieved The number of bytes written, possibly zero
throws:
  NonWritableChannelException - If this channel was not opened for writing
throws:
  ClosedChannelException - If this channel is closed
throws:
  AsynchronousCloseException - If another thread closes this channelwhile the write operation is in progress
throws:
  ClosedByInterruptException - If another thread interrupts the current threadwhile the write operation is in progress, therebyclosing the channel and setting the current thread'sinterrupt status
throws:
  IOException - If some other I/O error occurs



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.