| java.nio.channels.SelectableChannel
 java.nio.channels.spi.AbstractSelectableChannel
java.nio.channels.SocketChannel
| SocketChannel | | abstract public class SocketChannel extends AbstractSelectableChannel implements ByteChannel,ScatteringByteChannel,GatheringByteChannel(Code) | | A SocketChannel is a selectable channel for part abstraction of stream
connecting socket. The socket method of this class can return
the related Socket instance, which can handle the socket.
A socket channel is open but not connected when created by open
method. After connected by calling the connect method, it will
keep connected before closed. The connection is non-blocking that the
connect method is for the initial connection and following
finishConnect method is for the final steps of connection. The
isConnectionPending method can tell the connection is blocked
or not; the isConnected method can tell the socket is
connected finally or not.
The shut down operation can be independent and asynchronous for input and
output. The shutdownInput method is for input, and can make
the following read operation fail as end of stream. If the input is shut down
and another thread is pending in read operation, the read will end without
effect and return end of stream. The shutdownOutput method is
for output, and can make the following write operation throwing a
ClosedChannelException. If the output is shut down and
another is pending in a write operation, an
AsynchronousCloseException will thrown to the pending thread.
Socket channels are thread-safe, no more than one thread can read or write at
given time. The connect and finishConnect
methods are concurrent each other, when they are processing, other read and
write will block.
|
| Method Summary | |
| abstract public boolean | connect(SocketAddress address)
Connect the socket to remote address.
If the channel is blocking, this method will suspend before connection
finished or an I/O exception. | | abstract public boolean | finishConnect()
Complete the connection.
This method is used when the channel is connectable to finish the
connection, and the connectable status of a channel means the channel is
after initiating in non-blocking mode and calling its
connect method. | | abstract public boolean | isConnected()
Answer whether this channel's socket is connected or not. | | abstract public boolean | isConnectionPending()
Answer whether this channel's socket is in connecting or not. | | public static SocketChannel | open()
Create a open and not-connected socket channel. | | public static SocketChannel | open(SocketAddress address)
Create a socket channel and connect it to a socket address.
This method perform just as open method following by the
connect method.
Parameters:
address - The socket address to be connected. | | abstract public int | read(ByteBuffer target)
Reads bytes from the channel into the given buffer.
The maximum number of bytes that will be read is the
remaining() number of bytes in the buffer when the method
invoked. | | abstract public long | read(ByteBuffer[] targets, int offset, int length)
Reads bytes from the channel into a subset of the given buffers.
This method attempts to read all of the remaining() bytes
from length byte buffers, in order, starting at
targets[offset]. | | final public synchronized long | read(ByteBuffer[] targets)
Reads bytes from the channel into all the given buffers.
This method is equivalent to:
read(targets, 0, targets.length);
See Also: java.nio.channels.ScatteringByteChannel.read(java.nio.ByteBuffer[])
Parameters:
targets - the array of byte buffers to receive the bytes being read. | | abstract public Socket | socket()
Return the related socket of this channel, which won't declare public
methods that not declared in Socket. | | final public int | validOps()
Get the valid operations of this channel. | | abstract public int | write(ByteBuffer source)
Writes bytes from the given buffer to the channel.
The maximum number of bytes that will be written is the
remaining() number of bytes in the buffer when the method
invoked. | | abstract public long | write(ByteBuffer[] sources, int offset, int length)
Writes a subset of the given bytes from the buffers to the channel.
This method attempts to write all of the remaining() bytes
from length byte buffers, in order, starting at
sources[offset]. | | final public synchronized long | write(ByteBuffer[] sources)
Writes bytes from all the given buffers to the channel.
This method is equivalent to:
write(buffers, 0, buffers.length);
See Also: java.nio.channels.GatheringByteChannel.write(java.nio.ByteBuffer[])
Parameters:
sources - the buffers containing bytes to be written. |
| SocketChannel | | protected SocketChannel(SelectorProvider selectorProvider)(Code) | | Constructor for this class.
Parameters:
selectorProvider - A instance of SelectorProvider |
| connect | | abstract public boolean connect(SocketAddress address) throws IOException(Code) | | Connect the socket to remote address.
If the channel is blocking, this method will suspend before connection
finished or an I/O exception. If the channel is non-blocking, this method
will return true if the connection is finished at once or
return false and the connection must wait
finishConnect to finished otherwise.
This method can be called at any moment, and can block other read and
write operations while connecting.
This method just execute the same security checks as the connect method
of the Socket class.
Parameters:
address - The address to be connected. true if connection is finished,falseotherwise.
throws:
AlreadyConnectedException - If the channel is connected already.
throws:
ConnectionPendingException - A non-blocking connecting is doing on this channel.
throws:
ClosedChannelException - If the channel is already closed.
throws:
AsynchronousCloseException - If the channel is closed by another thread while this methodis in operation.
throws:
ClosedByInterruptException - If another thread interrupts the calling thread while theoperation is in progress. The calling thread will have theinterrupt state set, and the channel will be closed.
throws:
UnresolvedAddressException - If the address is not resolved.
throws:
UnsupportedAddressTypeException - If the address type is not supported.
throws:
SecurityException - If there is a security manager, and the address is notpermitted to access.
throws:
IOException - Some other IO error occurred. |
| finishConnect | | abstract public boolean finishConnect() throws IOException(Code) | | Complete the connection.
This method is used when the channel is connectable to finish the
connection, and the connectable status of a channel means the channel is
after initiating in non-blocking mode and calling its
connect method. It will throw related
IOException if the connection failed.
This method will return true if the connection is finished
already, and return false if the channel is non-blocking
and the connection is not finished yet.
If the channel is in blocking mode, this method will suspend, and return
true for connection finished or throw some exception
otherwise. The channel will be closed if the connection failed and this
method thrown some exception.
This method can be called at any moment, and can block other read and
write operations while connecting.
true if the connection is successfully finished,false otherwise.
throws:
NoConnectionPendingException - If the channel is not connected and the connection is notinitiated.
throws:
ClosedChannelException - If the channel is already closed.
throws:
AsynchronousCloseException - If the channel is closed by another thread while this methodis in operation.
throws:
ClosedByInterruptException - If another thread interrupts the calling thread while theoperation is in progress. The calling thread will have theinterrupt state set, and the channel will be closed.
throws:
IOException - Some other IO error occurred. |
| isConnected | | abstract public boolean isConnected()(Code) | | Answer whether this channel's socket is connected or not.
true for this channel's socket is connected;false otherwise. |
| isConnectionPending | | abstract public boolean isConnectionPending()(Code) | | Answer whether this channel's socket is in connecting or not.
true for the connection is initiated but notfinished; false otherwise. |
| open | | public static SocketChannel open() throws IOException(Code) | | Create a open and not-connected socket channel.
This channel is got by openSocketChannel method of the
default SelectorProvider instance.
The new created channel which is open but not-connected.
throws:
IOException - If some IO problem occurs. |
| open | | public static SocketChannel open(SocketAddress address) throws IOException(Code) | | Create a socket channel and connect it to a socket address.
This method perform just as open method following by the
connect method.
Parameters:
address - The socket address to be connected. The new opened channel.
throws:
AsynchronousCloseException - If the channel is closed by another thread while this methodis in operation.
throws:
ClosedByInterruptException - If another thread interrupts the calling thread while theoperation is in progress. The calling thread will have theinterrupt state set, and the channel will be closed.
throws:
UnresolvedAddressException - If the address is not resolved.
throws:
UnsupportedAddressTypeException - If the address type is not supported.
throws:
SecurityException - If there is a security manager, and the address is notpermitted to access.
throws:
IOException - Some other IO error occurred. |
| read | | abstract public int read(ByteBuffer target) throws IOException(Code) | | Reads bytes from the channel into the given buffer.
The maximum number of bytes that will be read is the
remaining() number of bytes in the buffer when the method
invoked. The bytes will be read into the buffer starting at the buffer's
position.
The call may block if other threads are also attempting to read on the
same channel.
Upon completion, the buffer's position() is updated to the
end of the bytes that were read. The buffer's limit() is
unmodified.
See Also: java.nio.channels.ReadableByteChannel.read(java.nio.ByteBuffer)
Parameters:
target - The byte buffer to receive the bytes. The number of bytes actually read.
throws:
NotYetConnectedException - If the channel is not connected yet.
throws:
ClosedChannelException - If the channel is already closed.
throws:
AsynchronousCloseException - If the channel is closed by another thread while this methodis in operation.
throws:
ClosedByInterruptException - If another thread interrupts the calling thread while theoperation is in progress. The calling thread will have theinterrupt state set, and the channel will be closed.
throws:
IOException - Some other IO error occurred. |
| read | | abstract public long read(ByteBuffer[] targets, int offset, int length) throws IOException(Code) | | Reads bytes from the channel into a subset of the given buffers.
This method attempts to read all of the remaining() bytes
from length byte buffers, in order, starting at
targets[offset]. The number of bytes actually read is
returned.
If a read operation is in progress, subsequent threads will block until
the read is completed, and will then contend for the ability to read.
See Also: java.nio.channels.ScatteringByteChannel.read(java.nio.ByteBuffer[]intint)
Parameters:
targets - the array of byte buffers into which the bytes will be read.
Parameters:
offset - the index of the first buffer to read.
Parameters:
length - the maximum number of buffers to read.
throws:
NotYetConnectedException - If the channel is not connected yet.
throws:
ClosedChannelException - If the channel is already closed.
throws:
AsynchronousCloseException - If the channel is closed by another thread while this methodis in operation.
throws:
ClosedByInterruptException - If another thread interrupts the calling thread while theoperation is in progress. The calling thread will have theinterrupt state set, and the channel will be closed.
throws:
IOException - Some other IO error occurred. |
| socket | | abstract public Socket socket()(Code) | | Return the related socket of this channel, which won't declare public
methods that not declared in Socket.
The related Socket instance. |
| validOps | | final public int validOps()(Code) | | Get the valid operations of this channel. Socket channels support
connect, read and write operation, so this method returns (
SelectionKey.OP_CONNECT |
SelectionKey.OP_READ | SelectionKey.OP_WRITE ).
See Also: java.nio.channels.SelectableChannel.validOps Valid operations in bit-set. |
| write | | abstract public int write(ByteBuffer source) throws IOException(Code) | | Writes bytes from the given buffer to the channel.
The maximum number of bytes that will be written is the
remaining() number of bytes in the buffer when the method
invoked. The bytes will be written from the buffer starting at the
buffer's position.
The call may block if other threads are also attempting to write on the
same channel.
Upon completion, the buffer's position() is updated to the
end of the bytes that were written. The buffer's limit()
is unmodified.
See Also: java.nio.channels.WritableByteChannel.write(java.nio.ByteBuffer)
Parameters:
source - the byte buffer containing the bytes to be written. the number of bytes actually written.
throws:
NotYetConnectedException - If the channel is not connected yet.
throws:
ClosedChannelException - If the channel is already closed.
throws:
AsynchronousCloseException - If the channel is closed by another thread while this methodis in operation.
throws:
ClosedByInterruptException - If another thread interrupts the calling thread while theoperation is in progress. The calling thread will have theinterrupt state set, and the channel will be closed.
throws:
IOException - Some other IO error occurred. |
| write | | abstract public long write(ByteBuffer[] sources, int offset, int length) throws IOException(Code) | | Writes a subset of the given bytes from the buffers to the channel.
This method attempts to write all of the remaining() bytes
from length byte buffers, in order, starting at
sources[offset]. The number of bytes actually written is
returned.
If a write operation is in progress, subsequent threads will block until
the write is completed, and will then contend for the ability to write.
See Also: java.nio.channels.GatheringByteChannel.write(java.nio.ByteBuffer[]intint)
Parameters:
sources - the array of byte buffers containing the source of remainingbytes that will be attempted to be written.
Parameters:
offset - the index of the first buffer to write.
Parameters:
length - the number of buffers to write. the number of bytes actually written.
throws:
NotYetConnectedException - If the channel is not connected yet.
throws:
ClosedChannelException - If the channel is already closed.
throws:
AsynchronousCloseException - If the channel is closed by another thread while this methodis in operation.
throws:
ClosedByInterruptException - If another thread interrupts the calling thread while theoperation is in progress. The calling thread will have theinterrupt state set, and the channel will be closed.
throws:
IOException - Some other IO error occurred. |
|
|