Класс SocketChannel

protected SocketChannel(SelectorProvider provider)

Инициализирует новый экземпляр этого класса.

public static SocketChannel open() throws IOException

Открывает сокет-канал для сокета протокола Интернет.

Новый канал создается путем вызова метода openSocketChannel глобального системного объекта SelectorProvider.

public static SocketChannel open(ProtocolFamily family) throws IOException

Открывает сокет-канал. Параметр family определяет protocol family сокета канала.

Новый канал создается путем вызова метода openSocketChannel(ProtocolFamily) глобального системного. SelectorProvider объекта.

public static SocketChannel open(SocketAddress remote) throws IOException

Открывает сокет-канал и подключает его к удаленному адресу.

Если удаленный адрес является InetSocketAddress, то этот метод работает так же, как если бы был вызван метод open(), метод connect был вызван на полученном сокет-канале, передавая ему remote, и затем возвращается этот канал.

Если удаленный адрес является UnixDomainSocketAddress, то это работает путем вызова метода open(ProtocolFamily) с StandardProtocolFamily.UNIX в качестве параметра, вызова метода connect на полученном сокет-канале, передавая ему remote, затем возвращая этот канал.

public final int validOps()

Возвращает набор операций, идентифицирующих поддерживаемые операции этого канала.

Сокет-каналы поддерживают подключение, чтение и запись, поэтому этот метод возвращает (SelectionKey.OP_CONNECT | SelectionKey.OP_READ | SelectionKey.OP_WRITE).

public abstract SocketChannel bind(SocketAddress local) throws IOException

Привязывает сокет канала к локальному адресу.

Этот метод используется для установления связи между сокетом и локальным адресом. Для сокетов протокола Интернет, после установления связи, сокет остается привязанным до закрытия канала. Если параметр local имеет значение null, то сокет будет привязан к автоматически назначенному адресу.

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

Устанавливает значение опции сокета.

public abstract SocketChannel shutdownInput() throws IOException

Закрывает подключение для чтения без закрытия канала.

После закрытия для чтения дальнейшие чтения из канала вернут -1, указание конца потока. Если сторона подключения для чтения уже закрыта, вызов этого метода не повлияет.

public abstract SocketChannel shutdownOutput() throws IOException

Закрывает подключение для записи без закрытия канала.

После закрытия для записи дальнейшие попытки записи в канал сгенерируют ClosedChannelException. Если сторона подключения для записи уже закрыта, вызов этого метода не повлияет.

public abstract Socket socket()

Возвращает сокет, связанный с этим каналом.

public abstract boolean isConnected()

Указывает, подключен ли сетевой сокет этого канала.

public abstract boolean isConnectionPending()

Указывает, происходит ли операция подключения к этому каналу.

public abstract boolean connect(SocketAddress remote) throws IOException

Подключает сокет этого канала.

Если этот канал находится в режиме асинхронного ввода-вывода, вызов этого метода инициирует асинхронную операцию подключения. Если подключение установлено немедленно, как может произойти при локальном подключении, то этот метод возвращает true. В противном случае этот метод возвращает false и операцию подключения необходимо завершить, вызвав метод finishConnect.

Если этот канал находится в режиме блокирующего ввода-вывода, вызов этого метода будет блокировать выполнение, пока подключение не будет установлено или не произойдёт ошибка ввода-вывода.

Для каналов с сокетами протокола Интернета этот метод выполняет точно такие же проверки безопасности, как и класс Socket. То есть, если менеджер безопасности был установлен, то этот метод проверяет, разрешает ли его метод checkConnect подключение к адресу и номеру порта заданного удалённого узла.

Для каналов с сокетами доменных адресов Unix этот метод проверяет NetPermission ("accessUnixDomainSocket") у менеджера безопасности с помощью метода checkPermission.

Этот метод можно вызывать в любое время. Если операция чтения или записи на этом канале вызывается во время выполнения вызова этого метода, то эта операция сначала будет блокироваться до завершения этого вызова. Если попытка подключения терпит неудачу, то есть, если вызов этого метода бросает проверяемое исключение, то канал будет закрыт.

public abstract boolean finishConnect() throws IOException

Завершает процесс подключения сокета канала.

Операция асинхронного подключения инициируется, поместив канал сокета в режим асинхронного ввода-вывода, а затем вызвав метод connect. После установления подключения или неудачи попытки подключение становится доступным, и этот метод может быть вызван для завершения последовательности подключения. Если операция подключения завершилась неудачей, то вызов этого метода вызовет соответствующее исключение IOException.

Если этот канал уже подключён, то этот метод не будет блокировать выполнение и немедленно вернёт true. Если этот канал находится в режиме асинхронного ввода-вывода, то этот метод вернёт false если процесс подключения ещё не завершён. Если этот канал находится в режиме блокирующего ввода-вывода, то этот метод будет блокировать выполнение до завершения или неудачи подключения, и всегда либо вернёт true или бросит проверяемое исключение, описывающее ошибку.

Этот метод может быть вызван в любое время. Если операция чтения или записи на этом канале вызывается во время выполнения вызова этого метода, то эта операция сначала будет блокироваться до завершения этого вызова. Если попытка подключения завершается неудачей, то есть, если вызов этого метода бросает проверяемое исключение, то канал будет закрыт.

public abstract SocketAddress getRemoteAddress() throws IOException

Возвращает удалённый адрес, к которому подключён сокет этого канала.

Если сокет канала привязан и подключён к адресу сокета протокола Интернета, то возвращаемое значение имеет тип InetSocketAddress.

Если сокет канала привязан и подключён к адресу сокета доменного адреса Unix, то возвращаемый адрес — UnixDomainSocketAddress.

public abstract int read(ByteBuffer dst) throws IOException

Считывает последовательность байтов из этого канала в заданный буфер.

Производится попытка чтения до r байтов из канала, где r — количество байтов, оставшихся в буфере, то есть, dst.remaining(), в момент вызова этого метода.

Предположим, что последовательность байтов длиной n была прочитана, где 0 <= n <= r. Эта последовательность байтов будет перенесена в буфер таким образом, что первый байт в последовательности будет в индексе p, а последний байт — в индексе p + n - 1, где p — позиция буфера в момент вызова этого метода. По завершении выполнения метод вернёт позицию буфера, равную p + n; его предел не изменится.

Операция чтения может не заполнить буфер, и, в действительности, может вообще не прочитать никаких байтов. Влияет ли это или нет, зависит от характера и состояния канала. Например, канал сокета в режиме асинхронного ввода-вывода не может прочитать больше байтов, чем сразу доступно в буфере ввода сокета; аналогично, канал файла не может прочитать больше байтов, чем остаётся в файле. Однако гарантируется, что если канал находится в режиме блокирующего ввода-вывода и в буфере есть хотя бы один байт, то этот метод будет блокировать выполнение до тех пор, пока не будет прочитан хотя бы один байт.

Этот метод можно вызывать в любое время. Однако, если другой поток уже инициировал операцию чтения на этом канале, то вызов этого метода будет блокировать выполнение до тех пор, пока первая операция не завершится.

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

Считывает последовательность байтов из этого канала в подпоследовательность заданных буферов.

Вызов этого метода пытается прочитать до 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], и так далее, пока вся последовательность байтов не будет передана в заданные буферы. В каждый буфер передаётся как можно больше байтов, поэтому конечная позиция каждого обновлённого буфера, кроме последнего обновлённого буфера, гарантированно равна пределу этого буфера.

Этот метод может быть вызван в любое время. Однако, если другой поток уже инициировал операцию чтения в этом канале, то вызов этого метода будет блокироваться до завершения первой операции.

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

Считывает последовательность байтов из этого канала в заданные буферы.

Вызов этого метода в форме c.read(dsts) ведет себя точно так же, как вызов

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

public abstract int write(ByteBuffer src) throws IOException

Записывает последовательность байтов в этот канал из заданного буфера.

Пытается записать до r байтов в канал, где r — количество оставшихся байтов в буфере, то есть, src.remaining(), в момент вызова этого метода.

Предположим, что записана последовательность байтов длиной n, где 0 <= n <= r. Эта последовательность байтов будет передана из буфера, начиная с индекса p, где p — позиция буфера в момент вызова этого метода; индекс последнего записанного байта будет p + n - 1. После возврата позиция буфера будет равна p + n; его предел не изменится.

Если не указано иное, операция записи вернётся только после записи всех r запрошенных байтов. Некоторые типы каналов, в зависимости от их состояния, могут записать только часть байтов или возможно вообще не записать. Например, сокет-канал в режиме без блокировки не может записать больше байтов, чем свободно в буфере вывода сокета.

Этот метод может быть вызван в любое время. Однако, если другой поток уже инициировал операцию записи в этот канал, то вызов этого метода будет блокироваться до завершения первой операции.

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

Записывает последовательность байтов в этот канал из подпоследовательности заданных буферов.

Пытается записать до 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 запрошенных байтов. Некоторые типы каналов, в зависимости от их состояния, могут записать только часть байтов или возможно вообще не записать. Например, сокет-канал в режиме без блокировки не может записать больше байтов, чем свободно в буфере вывода сокета.

Этот метод может быть вызван в любое время. Однако, если другой поток уже инициировал операцию записи в этот канал, то вызов этого метода будет блокироваться до завершения первой операции.

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

Записывает последовательность байтов в этот канал из заданных буферов.

Вызов этого метода в форме c.write(srcs) ведет себя точно так же, как вызов

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

public abstract SocketAddress getLocalAddress() throws IOException

Возвращает адрес сокета, к которому привязан сокет данного канала.

Если канал привязан к адресу сокета Интернета (Internet Protocol), то возвращаемое значение этого метода имеет тип InetSocketAddress. Если установлен менеджер безопасности, его метод checkConnect вызывается с локальным адресом и -1 в качестве аргументов, чтобы проверить разрешение операции. Если операция не разрешена, возвращается loopback адрес и локальный порт сокета канала.

Если канал привязан к адресу сокета Unix Domain, адрес сокета представляет собой UnixDomainSocketAddress. Если установлен менеджер безопасности, вызывается его метод checkPermission с NetPermission ("accessUnixDomainSocket"). Если операция не разрешена, возвращается безымянный UnixDomainSocketAddress.