java.nio.channels

Class SocketChannel

java.lang.Object

java.nio.channels.spi.AbstractInterruptibleChannel

java.nio.channels.SelectableChannel

java.nio.channels.spi.AbstractSelectableChannel

java.nio.channels.SocketChannel

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, ByteChannel, Channel, GatheringByteChannel, InterruptibleChannel, ReadableByteChannel, ScatteringByteChannel, WritableByteChannel

public abstract class SocketChannel
extends java.nio.channels.spi.AbstractSelectableChannel
implements ByteChannel, ScatteringByteChannel, GatheringByteChannel

Since:

1.4

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SocketChannel(java.nio.channels.spi.SelectorProvider provider) Initializes this socket channel.

Method Summary

Methods

Modifier and Type	Method and Description
abstract boolean	connect(java.net.SocketAddress remote) Connects the channel's socket to the remote address.
abstract boolean	finishConnect() Finishes the process of connecting a socket channel.
abstract boolean	isConnected() Tells whether or not the channel's 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(java.net.SocketAddress remote) Opens a channel and connects it to a remote address.
abstract int	read(java.nio.ByteBuffer dst) Reads data from the channel.
long	read(java.nio.ByteBuffer[] dsts) Reads data from the channel.
abstract long	read(java.nio.ByteBuffer[] dsts, int offset, int length) Reads data from the channel.
abstract java.net.Socket	socket() Retrieves the channel's socket.
int	validOps() Retrieves the valid operations for this channel.
abstract int	write(java.nio.ByteBuffer src) Writes data to the channel.
long	write(java.nio.ByteBuffer[] dsts) Writes data to the channel.
abstract long	write(java.nio.ByteBuffer[] srcs, int offset, int length) Writes data to the channel.

Methods inherited from class java.nio.channels.spi.AbstractSelectableChannel

blockingLock, configureBlocking, implCloseChannel, implCloseSelectableChannel, implConfigureBlocking, isBlocking, isRegistered, keyFor, provider, register

Methods inherited from class java.nio.channels.SelectableChannel

register

Methods inherited from class java.nio.channels.spi.AbstractInterruptibleChannel

begin, close, end, isOpen

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.nio.channels.Channel

close, isOpen

Constructor Detail

SocketChannel

protected SocketChannel(java.nio.channels.spi.SelectorProvider provider)

Initializes this socket channel.

Method Detail

open

public static SocketChannel open()
                          throws java.io.IOException

Opens a socket channel.

Returns:

the new SocketChannel object

Throws:

java.io.IOException - If an error occurs

open

public static SocketChannel open(java.net.SocketAddress remote)
                          throws java.io.IOException

Opens a channel and connects it to a remote address.

Returns:

the new SocketChannel object

Throws:

AsynchronousCloseException - If this channel is already connected.

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.

java.io.IOException - If an error occurs

java.lang.SecurityException - If a security manager has been installed and it does not permit access to the given remote endpoint.

UnresolvedAddressException - If the given remote address is not fully resolved.

UnsupportedAddressTypeException - If the type of the given remote address is not supported.

read

public final long read(java.nio.ByteBuffer[] dsts)
                throws java.io.IOException

Reads data from the channel.

Specified by:

read in interface ScatteringByteChannel

Returns:

the number of bytes read, zero is valid too, -1 if end of stream is reached

Throws:

java.io.IOException - If an error occurs

NotYetConnectedException - If this channel is not yet connected.

write

public final long write(java.nio.ByteBuffer[] dsts)
                 throws java.io.IOException

Writes data to the channel.

Specified by:

write in interface GatheringByteChannel

Returns:

the number of bytes written, zero is valid too

Throws:

java.io.IOException - If an error occurs

NotYetConnectedException - If this channel is not yet connected.

validOps

public final int validOps()

Retrieves the valid operations for this channel.

Specified by:

validOps in class SelectableChannel

Returns:

the valid operations

read

public abstract int read(java.nio.ByteBuffer dst)
                  throws java.io.IOException

Reads data from the channel.

Specified by:

read in interface ReadableByteChannel

Parameters:

dst - the buffer to put the read data into

Returns:

the number of bytes read, zero is valid too, -1 if end of stream is reached

Throws:

java.io.IOException - If an error occurs

NotYetConnectedException - If this channel is not yet connected.

connect

public abstract boolean connect(java.net.SocketAddress remote)
                         throws java.io.IOException

Connects the channel's socket to the remote address.

Returns:

true if the channel got successfully connected, false if the channel is in non-blocking mode and connection operation is still in progress.

Throws:

AlreadyConnectedException - If this channel is already connected.

AsynchronousCloseException - If this channel is already connected.

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.

ClosedChannelException - If this channel is closed.

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

java.io.IOException - If an error occurs

java.lang.SecurityException - If a security manager has been installed and it does not permit access to the given remote endpoint.

UnresolvedAddressException - If the given remote address is not fully resolved.

UnsupportedAddressTypeException - If the type of the given remote address is not supported.

finishConnect

public abstract boolean finishConnect()
                               throws java.io.IOException

Finishes the process of connecting a socket channel.

Throws:

AsynchronousCloseException - If this channel is already connected.

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.

ClosedChannelException - If this channel is closed.

java.io.IOException - If an error occurs

NoConnectionPendingException - If this channel is not connected and a connection operation has not been initiated.

isConnected

public abstract boolean isConnected()

Tells whether or not the channel's socket is connected.

isConnectionPending

public abstract boolean isConnectionPending()

Tells whether or not a connection operation is in progress on this channel.

read

public abstract long read(java.nio.ByteBuffer[] dsts,
        int offset,
        int length)
                   throws java.io.IOException

Reads data from the channel.

Specified by:

read in interface ScatteringByteChannel

Returns:

the number of bytes read, zero is valid too, -1 if end of stream is reached

Throws:

java.io.IOException - If an error occurs

NotYetConnectedException - If this channel is not yet connected.

socket

public abstract java.net.Socket socket()

Retrieves the channel's socket.

Returns:

the socket

write

public abstract int write(java.nio.ByteBuffer src)
                   throws java.io.IOException

Writes data to the channel.

Specified by:

write in interface WritableByteChannel

Returns:

the number of bytes written, zero is valid too

Throws:

java.io.IOException - If an error occurs

NotYetConnectedException - If this channel is not yet connected.

write

public abstract long write(java.nio.ByteBuffer[] srcs,
         int offset,
         int length)
                    throws java.io.IOException

Writes data to the channel.

Specified by:

write in interface GatheringByteChannel

Returns:

the number of bytes written, zero is valid too

Throws:

java.io.IOException - If an error occurs

NotYetConnectedException - If this channel is not yet connected.