|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object![]()
![]()
![]()
java.nio.channels.spi.AbstractInterruptibleChannel
![]()
![]()
![]()
java.nio.channels.SelectableChannel
![]()
![]()
![]()
java.nio.channels.spi.AbstractSelectableChannel
![]()
![]()
![]()
java.nio.channels.SocketChannel
, ByteChannel
, Channel
, GatheringByteChannel
, InterruptibleChannel
, ReadableByteChannel
, ScatteringByteChannel
, WritableByteChannel

public abstract class SocketChannel

, ScatteringByteChannel
, GatheringByteChannel

A selectable channel for stream-oriented connecting sockets.
Socket channels are not a complete abstraction of connecting network
sockets. Binding, shutdown, and the manipulation of socket options must be
done through an associated Socket
object obtained by
invoking the socket
method. It is not possible to create
a channel for an arbitrary, pre-existing socket, nor is it possible to
specify the SocketImpl
object to be used by a socket
associated with a socket channel.
A socket channel is created by invoking one of the open
methods of this class. A newly-created socket channel is open but not yet
connected. An attempt to invoke an I/O operation upon an unconnected
channel will cause a NotYetConnectedException
to be thrown. A
socket channel can be connected by invoking its connect
method; once connected, a socket channel remains connected until it is
closed. Whether or not a socket channel is connected may be determined by
invoking its isConnected
method.
Socket channels support non-blocking connection: A socket
channel may be created and the process of establishing the link to the
remote socket may be initiated via the connect
method for
later completion by the finishConnect
method.
Whether or not a connection operation is in progress may be determined by
invoking the isConnectionPending
method.
The input and output sides of a socket channel may independently be
shut down without actually closing the channel. Shutting down the
input side of a channel by invoking the shutdownInput
method of an associated socket object will cause further
reads on the channel to return -1, the end-of-stream indication.
Shutting down the output side of the channel by invoking the shutdownOutput
method of an associated
socket object will cause further writes on the channel to throw a ClosedChannelException
.
Socket channels support asynchronous shutdown, which is similar
to the asynchronous close operation specified in the Channel
class.
If the input side of a socket is shut down by one thread while another
thread is blocked in a read operation on the socket's channel, then the read
operation in the blocked thread will complete without reading any bytes and
will return -1. If the output side of a socket is shut down by one
thread while another thread is blocked in a write operation on the socket's
channel, then the blocked thread will receive an AsynchronousCloseException
.
Socket channels are safe for use by multiple concurrent threads. They
support concurrent reading and writing, though at most one thread may be
reading and at most one thread may be writing at any given time. The connect
and finishConnect
methods are
mutually synchronized against each other, and an attempt to initiate a read
or write operation while an invocation of one of these methods is in
progress will block until that invocation is complete.
| Constructor Summary | |
|---|---|
protected |
SocketChannel
Initializes a new instance of this class. |
| Method Summary | |
|---|---|
abstract boolean |
connect
Connects this channel's socket. |
abstract boolean |
finishConnect
Finishes the process of connecting a socket channel. |
abstract boolean |
isConnected
Tells whether or not this channel's network socket is connected. |
abstract boolean |
isConnectionPending
Tells whether or not a connection operation is in progress on this channel. |
static SocketChannel |
open
Opens a socket channel. |
static SocketChannel |
open
Opens a socket channel and connects it to a remote address. |
abstract int |
read
Reads a sequence of bytes from this channel into the given buffer. |
long |
read
Reads a sequence of bytes from this channel into the given buffers. |
abstract long |
read
Reads a sequence of bytes from this channel into a subsequence of the given buffers. |
abstract Socket |
socket
Retrieves a socket associated with this channel. |
int |
validOps
Returns an operation set identifying this channel's supported operations. |
abstract int |
write
Writes a sequence of bytes to this channel from the given buffer. |
long |
write
Writes a sequence of bytes to this channel from the given buffers. |
abstract long |
write
Writes a sequence of bytes to this channel from a subsequence of the given buffers. |
Methods inherited from class java.nio.channels.spi.AbstractSelectableChannel ![]() |
|---|
blockingLock |
Methods inherited from class java.nio.channels.SelectableChannel ![]() |
|---|
register |
Methods inherited from class java.nio.channels.spi.AbstractInterruptibleChannel ![]() |
|---|
begin |
Methods inherited from class java.lang.Object ![]() |
|---|
clone |
Methods inherited from interface java.nio.channels.Channel ![]() |
|---|
close |
Methods inherited from interface java.nio.channels.Channel ![]() |
|---|
close |
Methods inherited from interface java.nio.channels.Channel ![]() |
|---|
close |
Methods inherited from interface java.nio.channels.Channel ![]() |
|---|
close |
| Constructor Detail |
|---|

protected SocketChannel(SelectorProvider![]()
![]()
provider)
| Method Detail |
|---|

public static SocketChannel![]()
![]()
open() throws IOException
![]()
![]()
The new channel is created by invoking the openSocketChannel
method of the system-wide default SelectorProvider
object.
IOException

- If an I/O error occurs

public static SocketChannel![]()
![]()
open(SocketAddress
![]()
![]()
remote) throws IOException
![]()
![]()
This convenience method works as if by invoking the open()
method, invoking the connect
method upon
the resulting socket channel, passing it remote, and then
returning that channel.
remote - The remote address to which the new channel is to be connected
AsynchronousCloseException

- If another thread closes this channel
while the connect operation is in progress
ClosedByInterruptException

- If another thread interrupts the current thread
while the connect operation is in progress, thereby
closing the channel and setting the current thread's
interrupt status
UnresolvedAddressException

- If the given remote address is not fully resolved
UnsupportedAddressTypeException

- If the type of the given remote address is not supported
SecurityException

- If a security manager has been installed
and it does not permit access to the given remote endpoint
IOException

- If some other I/O error occurs

public final int validOps()
Socket channels support connecting, reading, and writing, so this
method returns (SelectionKey.OP_CONNECT
| SelectionKey.OP_READ
| SelectionKey.OP_WRITE
).
validOps

in class SelectableChannel


public abstract Socket![]()
![]()
socket()
The returned object will not declare any public methods that are not
declared in the Socket
class.

public abstract boolean isConnected()

public abstract boolean isConnectionPending()
finishConnect
method

public abstract boolean connect(SocketAddress![]()
![]()
remote) throws IOException
![]()
![]()
If this channel is in non-blocking mode then an invocation of this
method initiates a non-blocking connection operation. If the connection
is established immediately, as can happen with a local connection, then
this method returns true. Otherwise this method returns
false and the connection operation must later be completed by
invoking the finishConnect
method.
If this channel is in blocking mode then an invocation of this method will block until the connection is established or an I/O error occurs.
This method performs exactly the same security checks as the Socket
class. That is, if a security manager has been
installed then this method verifies that its checkConnect
method permits
connecting to the address and port number of the given remote endpoint.
This method may be invoked at any time. If a read or write operation upon this channel is invoked while an invocation of this method is in progress then that operation will first block until this invocation is complete. If a connection attempt is initiated but fails, that is, if an invocation of this method throws a checked exception, then the channel will be closed.
remote - The remote address to which this channel is to be connected
AlreadyConnectedException

- If this channel is already connected
ConnectionPendingException

- If a non-blocking connection operation is already in progress
on this channel
ClosedChannelException

- If this channel is closed
AsynchronousCloseException

- If another thread closes this channel
while the connect operation is in progress
ClosedByInterruptException

- If another thread interrupts the current thread
while the connect operation is in progress, thereby
closing the channel and setting the current thread's
interrupt status
UnresolvedAddressException

- If the given remote address is not fully resolved
UnsupportedAddressTypeException

- If the type of the given remote address is not supported
SecurityException

- If a security manager has been installed
and it does not permit access to the given remote endpoint
IOException

- If some other I/O error occurs

public abstract boolean finishConnect()
throws IOException

A non-blocking connection operation is initiated by placing a socket
channel in non-blocking mode and then invoking its connect
method. Once the connection is established, or the attempt has
failed, the socket channel will become connectable and this method may
be invoked to complete the connection sequence. If the connection
operation failed then invoking this method will cause an appropriate
IOException
to be thrown.
If this channel is already connected then this method will not block and will immediately return true. If this channel is in non-blocking mode then this method will return false if the connection process is not yet complete. If this channel is in blocking mode then this method will block until the connection either completes or fails, and will always either return true or throw a checked exception describing the failure.
This method may be invoked at any time. If a read or write operation upon this channel is invoked while an invocation of this method is in progress then that operation will first block until this invocation is complete. If a connection attempt fails, that is, if an invocation of this method throws a checked exception, then the channel will be closed.