compact1, compact2, compact3

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:

Closeable ， AutoCloseable ， ByteChannel ， Channel ， GatheringByteChannel ， InterruptibleChannel ， NetworkChannel ， ReadableByteChannel ， ScatteringByteChannel ， WritableByteChannel

public abstract class SocketChannel
extends AbstractSelectableChannel
implements ByteChannel, ScatteringByteChannel, GatheringByteChannel, NetworkChannel

用于面向流的连接插座的可选通道。

通过调用此类的open方法之一创建套接字通道。 不可能为任意的预先存在的套接字创建一个通道。 新创建的套接字通道已打开但尚未连接。 尝试在未连接的通道上调用I / O操作将导致抛出NotYetConnectedException 。 可以通过调用其connect方法连接套接字通道; 一旦连接，插座通道保持连接，直到其闭合。 是否连接套接字通道可以通过调用其isConnected方法来确定 。

套接字通道支持非阻塞连接：可以创建套接字通道，并且可以通过connect方法启动建立到远程套接字的链接的过程，以便稍后完成finishConnect方法。 连接操作是否正在进行可以通过调用isConnectionPending方法来确定。

Socket通道支持异步关闭，类似于Channel类中指定的异步关闭操作。 如果套接字的输入端由一个线程关闭，而另一个线程在套接字通道的读操作中被阻塞，则阻塞线程中的读操作将完成，而不读任何字节，并将返回-1 。 如果套接字的输出端由一个线程关闭，而另一个线程在套接字通道的写操作中被阻塞，则阻塞的线程将接收到一个AsynchronousCloseException 。

套接字选项使用setOption方法进行配置。 套接字通道支持以下选项：

Option Name	描述
SO_SNDBUF	The size of the socket send buffer
SO_RCVBUF	The size of the socket receive buffer
SO_KEEPALIVE	Keep connection alive
SO_REUSEADDR	Re-use address
SO_LINGER	Linger on close if data is present (when configured in blocking mode only)
TCP_NODELAY	Disable the Nagle algorithm

还可以支持附加（实现特定）选项。

套接字通道可以安全地被多个并发线程使用。 他们支持并发阅读和写作，但最多只有一个线程可能正在读取，并且最多一个线程可能在任何给定的时间写入。 connect和finishConnect方法彼此相互同步，并且在调用这些方法之一的过程中尝试发起读取或写入操作将阻塞直到该调用完成。

从以下版本开始：

1.4

构造方法摘要

构造方法

Modifier	Constructor and Description
protected	SocketChannel(SelectorProvider provider) 初始化此类的新实例。

方法摘要

Modifier and Type	Method and Description
abstract SocketChannel	bind(SocketAddress local) 将通道的套接字绑定到本地地址。
abstract boolean	connect(SocketAddress remote) 连接此通道的插座。
abstract boolean	finishConnect() 完成连接插座通道的过程。
abstract SocketAddress	getLocalAddress() 返回此通道的套接字所绑定的套接字地址。
abstract SocketAddress	getRemoteAddress() 返回此通道的插座所连接的远程地址。
abstract boolean	isConnected() 告知本频道的网络插座是否连接。
abstract boolean	isConnectionPending() 告知此频道是否正在进行连接操作。
static SocketChannel	open() 打开套接字通道。
static SocketChannel	open(SocketAddress remote) 打开套接字通道并将其连接到远程地址。
abstract int	read(ByteBuffer dst) 从该通道读取到给定缓冲区的字节序列。
long	read(ByteBuffer[] dsts) 从该通道读取到给定缓冲区的字节序列。
abstract long	read(ByteBuffer[] dsts, int offset, int length) 从该通道读取字节序列到给定缓冲区的子序列中。
abstract <T> SocketChannel	setOption(SocketOption<T> name, T value) 设置套接字选项的值。
abstract SocketChannel	shutdownInput() 关闭连接进行阅读，不关闭频道。
abstract SocketChannel	shutdownOutput() 关闭连接以进行写入，而不关闭通道。
abstract Socket	socket() 检索与此通道相关联的套接字。
int	validOps() 返回确定此频道支持的操作的操作集。
abstract int	write(ByteBuffer src) 从给定的缓冲区向该通道写入一个字节序列。
long	write(ByteBuffer[] srcs) 从给定的缓冲区向该通道写入一系列字节。
abstract long	write(ByteBuffer[] srcs, int offset, int length) 从给定缓冲区的子序列将一个字节序列写入该通道。

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

Methods inherited from interface java.nio.channels.NetworkChannel

getOption, supportedOptions

构造方法详细信息

SocketChannel

protected SocketChannel(SelectorProvider provider)

初始化此类的新实例。

参数

provider - 创建此频道的提供商

方法详细信息

open

public static SocketChannel open()
                          throws IOException

打开套接字通道。

通过调用系统范围的默认SelectorProvider对象的openSocketChannel方法创建新通道。

结果

一个新的套接字通道

异常

IOException - 如果发生I / O错误

open

public static SocketChannel open(SocketAddress remote)
                          throws IOException

打开套接字通道并将其连接到远程地址。

这种方便的方法就像通过调用open()方法一样工作，调用89419042942426方法在产生的套接字通道上传递remote ，然后返回该通道。

参数

remote - 要连接新通道的远程地址

结果

一个新的和连接的插座通道

异常

AsynchronousCloseException - 如果另一个线程在连接操作进行过程中关闭此通道

ClosedByInterruptException - 如果另一个线程在连接操作进行过程中中断当前线程，则关闭通道并设置当前线程的中断状态

UnresolvedAddressException - 如果给定的远程地址没有完全解决

UnsupportedAddressTypeException - 如果不支持给定的远程地址的类型

SecurityException - 如果已安装安全管理器，并且不允许访问给定的远程端点

IOException - 如果发生其他I / O错误

validOps

public final int validOps()

返回确定此频道支持的操作的操作集。

套接字通道支持连接，读取和写入，因此该方法返回( SelectionKey.OP_CONNECT | SelectionKey.OP_READ | SelectionKey.OP_WRITE ) 。

Specified by:

validOps在 SelectableChannel

结果

有效操作集

bind

public abstract SocketChannel bind(SocketAddress local)
                            throws IOException

说明从接口： NetworkChannel复制

将通道的套接字绑定到本地地址。

该方法用于在套接字和本地地址之间建立关联。 一旦建立关联，则套接字保持绑定，直到通道关闭。 如果local参数的值为null则套接字将被绑定到自动分配的地址。

Specified by:

bind在接口 NetworkChannel

参数

local - 绑定套接字的地址，或 null将套接字绑定到自动分配的套接字地址

结果

这个频道

异常

ConnectionPendingException - 如果该通道上已经在进行非阻塞连接操作

AlreadyBoundException - 如果套接字已经绑定

UnsupportedAddressTypeException - 如果不支持给定地址的类型

ClosedChannelException - 如果通道关闭

IOException - 如果发生其他I / O错误

SecurityException - 如果已安装安全管理员，并且其 checkListen方法拒绝操作

从以下版本开始：

1.7

另请参见：

NetworkChannel.getLocalAddress()

setOption

public abstract <T> SocketChannel setOption(SocketOption<T> name,
                                            T value)
                                     throws IOException

说明从界面复制： NetworkChannel

设置套接字选项的值。

Specified by:

setOption在接口 NetworkChannel

参数类型

T - 套接字选项值的类型

参数

name - 套接字选项

value - 套接字选项的值。 值为null可能是某些套接字选项的有效值。

结果

这个频道

异常

UnsupportedOperationException - 如果此通道不支持套接字选项

IllegalArgumentException - 如果该值不是此套接字选项的有效值

ClosedChannelException - 如果此通道关闭

IOException - 如果发生I / O错误

从以下版本开始：

1.7

另请参见：

StandardSocketOptions

shutdownInput

public abstract SocketChannel shutdownInput()
                                     throws IOException

关闭连接进行阅读，不关闭频道。

一旦关机进行读取，则通道上的进一步读取将返回-1流末端指示。 如果连接的输入端已经关闭，则调用此方法没有任何作用。

结果

这个频道

异常

NotYetConnectedException - 如果此频道尚未连接

ClosedChannelException - 如果此通道关闭

IOException - 如果发生其他I / O错误

从以下版本开始：

1.7

shutdownOutput

public abstract SocketChannel shutdownOutput()
                                      throws IOException

关闭连接以进行写入，而不关闭通道。

一旦关闭写入，则进一步尝试写入通道会抛出ClosedChannelException 。 如果连接的输出端已经关闭，则调用此方法不起作用。

结果

这个频道

异常

NotYetConnectedException - 如果此频道尚未连接

ClosedChannelException - 如果此通道关闭

IOException - 如果发生其他I / O错误

从以下版本开始：

1.7

socket

public abstract Socket socket()

检索与此通道相关联的套接字。

返回的对象不会声明任何没有在Socket类中声明的公共方法。

结果

与此通道相关联的插座

isConnected

public abstract boolean isConnected()

告知本频道的网络插座是否连接。

结果

true如果，并且只有这个频道的网络套接字是 open并连接

isConnectionPending

public abstract boolean isConnectionPending()

告知此频道是否正在进行连接操作。

结果

true如果并且只有在此通道上已启动连接操作但尚未通过调用 finishConnect方法完成

connect

public abstract boolean connect(SocketAddress remote)
                         throws IOException

连接此通道的插座。

如果此通道处于非阻塞模式，则此方法的调用将启动非阻塞连接操作。 如果立即建立连接，就像本地连接一样，该方法返回true 。 否则，此方法返回false ，并且连接操作必须稍后通过调用finishConnect方法完成。

如果此通道处于阻塞模式，则该方法的调用将阻塞，直到建立连接或发生I / O错误。

此方法执行与Socket类完全相同的安全检查。 也就是说，如果安装了一个安全管理器，则该方法验证其checkConnect方法是否允许连接到给定远程端点的地址和端口号。

可以随时调用此方法。 如果在调用此方法时调用此通道的读取或写入操作，则该操作将首先阻止，直到此调用完成。 如果连接尝试启动但失败，也就是说，如果此方法的调用抛出已检查的异常，则该通道将被关闭。

参数

remote - 要连接该通道的远程地址

结果

true如果连接建立， false如果该通道处于非阻塞模式并且连接操作正在进行中

异常

AlreadyConnectedException - 如果此频道已连接

ConnectionPendingException - 如果该通道上已经进行了非阻塞连接操作

ClosedChannelException - 如果此通道关闭

AsynchronousCloseException - 如果另一个线程在连接操作进行过程中关闭此通道

ClosedByInterruptException - 如果另一个线程在连接操作正在进行时中断当前线程，从而关闭通道并设置当前线程的中断状态

UnresolvedAddressException - 如果给定的远程地址未完全解析

UnsupportedAddressTypeException - 如果不支持给定的远程地址的类型

SecurityException - 如果已安装安全管理器，并且不允许访问给定的远程端点

IOException - 如果发生其他I / O错误

finishConnect

public abstract boolean finishConnect()
                               throws IOException

完成连接插座通道的过程。

通过将套接字通道置于非阻塞模式，然后调用其connect方法来启动非阻塞连接操作。 一旦建立了连接，或尝试失败，套接字通道将变得可连接，并且可以调用该方法来完成连接顺序。 如果连接操作失败，则调用此方法将导致适当的IOException被抛出。

如果此通道已连接，则此方法将不会阻止并立即返回true 。 如果此通道处于非阻塞模式，则如果连接过程尚未完成，则此方法将返回false 。 如果此通道处于阻塞模式，则该方法将阻塞，直到连接完成或失败，并且将始终返回true或抛出描述失败的已检查异常。

可以随时调用此方法。 如果在调用此方法时调用此通道的读取或写入操作，则该操作将首先阻止，直到此调用完成。 如果连接尝试失败，也就是说，如果此方法的调用引发已检查的异常，那么该通道将被关闭。

结果

true如果，且仅当此通道的插座现在已连接

异常

NoConnectionPendingException - 如果此通道未连接，并且未启动连接操作

ClosedChannelException - 如果此通道关闭

AsynchronousCloseException - 如果另一个线程在连接操作进行中时关闭此通道

ClosedByInterruptException - 如果另一个线程在连接操作进行过程中中断当前线程，从而关闭通道并设置当前线程的中断状态

IOException - 如果发生其他I / O错误

getRemoteAddress

public abstract SocketAddress getRemoteAddress()
                                        throws IOException

返回此通道的插座所连接的远程地址。

通道绑定并连接到Internet协议套接字地址时，此方法的返回值为InetSocketAddress 。

结果

远程地址; null如果通道的插座未连接

异常

ClosedChannelException - 如果通道关闭

IOException - 如果发生I / O错误

从以下版本开始：

1.7

read

public abstract int read(ByteBuffer dst)
                  throws IOException

说明从界面： ReadableByteChannel复制

从该通道读取到给定缓冲区的字节序列。

尝试从通道读取r个字节，其中r是缓冲区中剩余的字节数，即dst.remaining() ，在该方法被调用的时刻。

假设读取长度为n的字节序列，其中88419044412022 <= n <= r 。 该字节序列将被转移到缓冲器，使得序列中的第一个字节是在索引p和最后一个字节是在索引p + -Ñ1，其中p是该缓冲区的在调用此方法的瞬间位置。 缓冲区的返回位置将等于p + n ; 其限制将不会改变。

读取操作可能不会填充缓冲区，实际上它可能不会读取任何字节。 是否这样做取决于渠道的性质和状态。 例如，非阻塞模式的套接字通道不能再读取比从套接字的输入缓冲区可以立即获得的任何字节数; 类似地，文件通道不能读取比保留在文件中的任何更多的字节。 但是，如果通道处于阻塞模式，并且缓冲区中至少剩余一个字节，则该方法将被阻塞，直到读取至少一个字节为止。

可以随时调用此方法。 但是，如果另一个线程已经在该通道上启动了读取操作，那么此方法的调用将阻塞，直到第一个操作完成。

Specified by:

read在接口 ReadableByteChannel

参数

dst - 要传输字节的缓冲区

结果

读取的字节数，可能为零，如果通道已达到流出端， 则为-1

异常

NotYetConnectedException - 如果此频道尚未连接

ClosedChannelException - 如果此通道关闭

AsynchronousCloseException - 如果另一个线程在读取操作正在进行时关闭此通道

ClosedByInterruptException - 如果另一个线程在读取操作正在进行中断当前线程，从而关闭通道并设置当前线程的中断状态

IOException - 如果发生其他I / O错误

read

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

说明从界面： ScatteringByteChannel复制

从该通道读取字节序列到给定缓冲区的子序列中。

该方法的调用尝试从该通道读取r个字节，其中r是给定缓冲区数组的指定子序列剩余的总字节数，也就是说，

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

在此方法被调用的时刻。

假设读取长度为n的字节序列，其中0 <= n <= r 。 直到该序列的第一个dsts[offset].remaining()字节被传送到缓冲器dsts[offset] ，直到下一个dsts[offset+1].remaining()字节被传送到缓冲器dsts[offset+1]等等，直到整个字节序列被传送到给定的缓冲器。 尽可能多的字节被传送到每个缓冲器中，因此除了最后更新的缓冲器之外，每个更新的缓冲器的最终位置被保证等于该缓冲器的限制。

可以随时调用此方法。 但是，如果另一个线程已经在该通道上启动了读取操作，那么此方法的调用将阻塞，直到第一个操作完成。

Specified by:

read在接口 ScatteringByteChannel

参数

dsts - 要传输字节的缓冲区

offset - 要传输字节的第一个缓冲区的缓冲区中的偏移量; 必须是非负数，不得大于dsts.length

length - 要访问的缓冲区的最大数量; 必须是非负数，不得大于dsts.length - offset

结果

读取的字节数，可能为零，如果通道已达到流出端， 则为-1

异常

NotYetConnectedException - 如果此频道尚未连接

ClosedChannelException - 如果此通道关闭

AsynchronousCloseException - 如果另一个线程在读取操作正在进行时关闭此通道

ClosedByInterruptException - 如果另一个线程在读取操作正在进行时中断当前线程，从而关闭通道并设置当前线程的中断状态

IOException - 如果发生其他I / O错误

read

public final long read(ByteBuffer[] dsts)
                throws IOException

从接口复制： ScatteringByteChannel

从该通道读取到给定缓冲区的字节序列。

调用此方法的形式为c.read(dsts)的行为方式与调用完全相同

 c.read(dsts, 0, dsts.length);

Specified by:

read在界面 ScatteringByteChannel

参数

dsts - 要传输字节的缓冲区

结果

读取的字节数，可能为零，如果通道已达到流出端， 则为-1

异常

NotYetConnectedException - 如果此频道尚未连接

ClosedChannelException - 如果此通道关闭

AsynchronousCloseException - 如果另一个线程在读操作正在进行时关闭此通道

ClosedByInterruptException - 如果另一个线程在读取操作正在进行中断当前线程，从而关闭通道并设置当前线程的中断状态

IOException - 如果发生其他I / O错误

write

public abstract int write(ByteBuffer src)
                   throws IOException

描述从接口： WritableByteChannel复制

从给定的缓冲区向该通道写入一个字节序列。

尝试写入r个字节到通道，其中r是缓冲区中剩余的字节数，即src.remaining() ，在此方法被调用的时刻。

假设写入长度为n的字节序列，其中0 <= n <= r 。 该字节序列将从索引p开始从缓冲区传送，其中p是调用该方法时缓冲区的位置; 写入的最后一个字节的索引将为p + n - 1 。 缓冲区的返回位置将等于p + n ; 其限制将不会改变。

除非另有规定，写入操作将仅在写入所有r个请求的字节后才会返回。 某些类型的通道取决于它们的状态，可能仅写入一些字节，或者可能只写入一些字节。 例如，在非阻塞模式下的套接字通道不能再写入比套接字输出缓冲区中的任何字节更多的字节。

可以随时调用此方法。 但是，如果另一个线程已经在该通道上启动了写入操作，那么此方法的调用将阻塞，直到第一个操作完成。

Specified by:

write在接口 WritableByteChannel

参数

src - 要检索字节的缓冲区

结果

写入的字节数，可能为零

异常

NotYetConnectedException - 如果此频道尚未连接

ClosedChannelException - 如果此通道关闭

AsynchronousCloseException - 如果另一个线程在写操作正在进行时关闭此通道

ClosedByInterruptException - 如果另一个线程在写入操作进行过程中中断当前线程，从而关闭通道并设置当前线程的中断状态

IOException - 如果发生其他I / O错误

write

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

说明从界面： GatheringByteChannel复制

从给定缓冲区的子序列将一个字节序列写入该通道。

尝试写入r个字节到该通道，其中r是给定缓冲区数组的指定子序列中剩余的总字节数，也就是说，

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

在此方法被调用的时刻。

假设写入长度为n的字节序列，其中0 <= n <= r 。 直到该序列的第一个srcs[offset].remaining()字节从缓冲器srcs[offset]写入，直到下一个srcs[offset+1].remaining()字节从缓冲器srcs[offset+1]写入，等等，直到写入整个字节序列。 尽可能多的字节从每个缓冲区写入，因此除了最后更新的缓冲区之外，每个更新的缓冲区的最终位置被保证等于该缓冲区的限制。

除非另有规定，写入操作将仅在写入所有r个请求的字节后才会返回。 某些类型的通道取决于它们的状态，可能仅写入一些字节，或者可能只写入一些字节。 例如，在非阻塞模式下的套接字通道不能再写入比套接字输出缓冲区中的任何字节更多的字节。

可以随时调用此方法。 但是，如果另一个线程已经在该通道上启动了写入操作，那么此方法的调用将阻塞，直到第一个操作完成。

Specified by:

write中的 GatheringByteChannel

参数

srcs - 要检索字节的缓冲区

offset - 要从中检索字节的第一个缓冲区的缓冲区数组中的偏移量; 必须是非负数，不得大于srcs.length

length - 要访问的缓冲区的最大数量; 必须是非负数，不得大于srcs.length - offset

结果

写入的字节数，可能为零

异常

NotYetConnectedException - 如果此频道尚未连接

ClosedChannelException - 如果此通道关闭

AsynchronousCloseException - 如果另一个线程在写操作正在进行时关闭此通道

ClosedByInterruptException - 如果另一个线程在写操作正在进行时中断当前线程，从而关闭通道并设置当前线程的中断状态

IOException - 如果发生其他I / O错误

write

public final long write(ByteBuffer[] srcs)
                 throws IOException

描述从接口： GatheringByteChannel复制

从给定的缓冲区向该通道写入一系列字节。

调用此方法的形式为c.write(srcs)的行为方式与调用完全相同

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

Specified by:

write在接口 GatheringByteChannel

参数

srcs - 要检索字节的缓冲区

结果

写入的字节数，可能为零

异常

NotYetConnectedException - 如果此频道尚未连接

ClosedChannelException - 如果此通道关闭

AsynchronousCloseException - 如果另一个线程在写操作正在进行时关闭此通道

ClosedByInterruptException - 如果另一个线程在写操作正在进行时中断当前线程，从而关闭通道并设置当前线程的中断状态

IOException - 如果发生其他I / O错误

getLocalAddress

public abstract SocketAddress getLocalAddress()
                                       throws IOException

返回此通道的套接字所绑定的套接字地址。

通道为Internet协议套接字地址的bound ，则此方法的返回值为InetSocketAddress 。

如果有一个安全管理器集，它的checkConnect方法被调用本地地址和-1作为参数来查看是否允许该操作。 如果不允许的操作， SocketAddress代表loopback个地址和通道的套接字的本地端口返回。

Specified by:

getLocalAddress中的 NetworkChannel

结果

该 SocketAddress ，该套接字绑定到，或 SocketAddress代表的环回地址，如果安全管理器拒绝，或 null如果通道的套接字不绑定

异常

ClosedChannelException - 如果通道关闭

IOException - 如果发生I / O错误