Класс AsynchronousSocketChannel

protected AsynchronousSocketChannel(AsynchronousChannelProvider provider)

Параметры:

provider — Провайдер, создавший этот канал

public final AsynchronousChannelProvider provider()

Возвращает:

Провайдер, создавший этот канал

public static AsynchronousSocketChannel open(AsynchronousChannelGroup group) throws IOException

Параметры:

group — Группа, к которой должен быть привязан вновь созданный канал, или null для группы по умолчанию

Возвращает:

Новый асинхронный сокетный канал

Выбрасывает:

ShutdownChannelGroupException — Если работа группы каналов завершена

IOException — Если произошла ошибка ввода-вывода

public static AsynchronousSocketChannel open() throws IOException

    open((AsynchronousChannelGroup)null);

Возвращает:

Новый асинхронный сокетный канал

Выбрасывает:

IOException — Если произошла ошибка ввода-вывода

public abstract AsynchronousSocketChannel bind(SocketAddress local) throws IOException

Определено в:

bind в интерфейсе NetworkChannel

Параметры:

local — Адрес, к которому нужно привязать сокет, или null, чтобы привязать сокет к автоматически назначенному адресу сокета

Возвращает:

Этот канал

Выбрасывает:

ConnectionPendingException — Если в этом канале уже выполняется операция подключения

AlreadyBoundException — Если сокет уже привязан

UnsupportedAddressTypeException — Если тип указанного адреса не поддерживается

ClosedChannelException — Если канал закрыт

IOException — Если произошла другая ошибка ввода-вывода

См. также:

• NetworkChannel.getLocalAddress()

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

Определено в:

setOption в интерфейсе NetworkChannel

Параметры типа:

T — Тип значения параметра сокета

Параметры:

name — Параметр сокета

value — Значение параметра сокета. Значение null может быть допустимым для некоторых параметров сокета.

Возвращает:

Этот канал

Выбрасывает:

IllegalArgumentException — Если значение недопустимо для этого параметра сокета

ClosedChannelException — Если этот канал закрыт

IOException — Если произошла ошибка ввода-вывода

См. также:

• StandardSocketOptions

public abstract AsynchronousSocketChannel shutdownInput() throws IOException

Возвращает:

Канал

Выбрасывает:

NotYetConnectedException — Если это соединение канала еще не установлено

ClosedChannelException — Если этот канал закрыт

IOException — Если произошла другая ошибка ввода-вывода

public abstract AsynchronousSocketChannel shutdownOutput() throws IOException

Возвращает:

Канал

Выбрасывает:

NotYetConnectedException — Если это соединение канала еще не установлено

ClosedChannelException — Если этот канал закрыт

IOException — Если произошла другая ошибка ввода-вывода

public abstract SocketAddress getRemoteAddress() throws IOException

Возвращает:

Удаленный адрес; null, если сокет канала не подключен

Выбрасывает:

ClosedChannelException — Если канал закрыт

IOException — Если произошла ошибка ввода-вывода

public abstract <A> void connect(SocketAddress remote, A attachment, CompletionHandler<Void, ? super A> handler)

Параметры типа:

A — Тип прикрепленного объекта

Параметры:

remote — Удаленный адрес, к которому нужно подключить этот канал

attachment — Объект, прикрепляемый к операции ввода-вывода; может быть null

handler — Обработчик для получения результата

Выбрасывает:

UnresolvedAddressException — Если указанный удаленный адрес разрешен не полностью

UnsupportedAddressTypeException — Если тип указанного удаленного адреса не поддерживается

AlreadyConnectedException — Если этот канал уже подключен

ConnectionPendingException — Если в этом канале уже выполняется операция подключения

ShutdownChannelGroupException — Если работа группы каналов завершена

См. также:

• getRemoteAddress()

public abstract Future<Void> connect(SocketAddress remote)

Параметры:

remote — Удаленный адрес, к которому нужно подключить этот канал

Возвращает:

Объект Future, представляющий ожидающий результат

Выбрасывает:

UnresolvedAddressException — Если указанный удаленный адрес разрешен не полностью

UnsupportedAddressTypeException — Если тип указанного удаленного адреса не поддерживается

AlreadyConnectedException — Если этот канал уже подключен

ConnectionPendingException — Если в этом канале уже выполняется операция подключения

public abstract <A> void read(ByteBuffer dst, long timeout, TimeUnit unit, A attachment, CompletionHandler<Integer, ? super A> handler)

Параметры типа:

A — Тип прикрепленного объекта

Параметры:

dst — Буфер, в который будут переданы байты

timeout — Максимальное время, отведенное на завершение операции ввода-вывода

unit — Единица измерения времени аргумента timeout

attachment — Объект, прикрепляемый к операции ввода-вывода; может быть null

handler — Обработчик для получения результата

Выбрасывает:

IllegalArgumentException — Если буфер доступен только для чтения или является представлением MemorySegment, выделенного из арены с привязкой к потоку

ReadPendingException — Если в этом канале уже выполняется операция чтения

NotYetConnectedException — Если этот канал еще не подключен

ShutdownChannelGroupException — Если работа группы каналов завершена

public final <A> void read(ByteBuffer dst, A attachment, CompletionHandler<Integer, ? super A> handler)

Определено в:

read в интерфейсе AsynchronousByteChannel

Параметры типа:

A — Тип прикрепленного объекта

Параметры:

dst — Буфер, в который будут переданы байты

attachment — Объект, прикрепляемый к операции ввода-вывода; может быть null

handler — Обработчик завершения

Выбрасывает:

IllegalArgumentException — Если буфер доступен только для чтения или является представлением MemorySegment, выделенного из арены с привязкой к потоку

ReadPendingException — Если канал не допускает более одной незавершенной операции чтения и предыдущая операция чтения еще не завершена

NotYetConnectedException — Если этот канал еще не подключен

ShutdownChannelGroupException — Если работа группы каналов завершена

public abstract Future<Integer> read(ByteBuffer dst)

Определено в:

read в интерфейсе AsynchronousByteChannel

Параметры:

dst — Буфер, в который будут переданы байты

Возвращает:

Future, представляющий результат операции

Выбрасывает:

IllegalArgumentException — Если буфер доступен только для чтения или является представлением MemorySegment, выделенного из арены с привязкой к потоку

ReadPendingException — Если канал не допускает более одной незавершенной операции чтения и предыдущая операция чтения еще не завершена

NotYetConnectedException — Если этот канал еще не подключен

public abstract <A> void read(ByteBuffer[] dsts, int offset, int length, long timeout, TimeUnit unit, A attachment, CompletionHandler<Long, ? super A> handler)

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

Параметры типа:

A — Тип прикрепленного объекта

Параметры:

dsts — Буферы, в которые будут переданы байты

offset — Смещение в массиве буферов первого буфера, в который будут переданы байты; должно быть неотрицательным и не превышать dsts.length

length — Максимальное количество буферов для доступа; должно быть неотрицательным и не превышать dsts.length - offset

timeout — Максимальное время, отведенное на завершение операции ввода-вывода

unit — Единица измерения времени аргумента timeout

attachment — Объект, прикрепляемый к операции ввода-вывода; может быть null

handler — Обработчик для получения результата

Выбрасывает:

IndexOutOfBoundsException — Если не выполнены предварительные условия для параметров offset и length

IllegalArgumentException — Если какой-либо буфер доступен только для чтения или является представлением MemorySegment, выделенного из арены с привязкой к потоку

ReadPendingException — Если в этом канале уже выполняется операция чтения

NotYetConnectedException — Если этот канал еще не подключен

ShutdownChannelGroupException — Если работа группы каналов завершена

public abstract <A> void write(ByteBuffer src, long timeout, TimeUnit unit, A attachment, CompletionHandler<Integer, ? super A> handler)

Параметры типа:

A — Тип прикрепленного объекта

Параметры:

src — Буфер, из которого будут получены байты

timeout — Максимальное время, отведенное на завершение операции ввода-вывода

unit — Единица измерения времени аргумента timeout

attachment — Объект, прикрепляемый к операции ввода-вывода; может быть null

handler — Обработчик для получения результата

Выбрасывает:

IllegalArgumentException — Если буфер является представлением MemorySegment, выделенного из арены с привязкой к потоку

WritePendingException — Если в этом канале уже выполняется операция записи

NotYetConnectedException — Если этот канал еще не подключен

ShutdownChannelGroupException — Если работа группы каналов завершена

public final <A> void write(ByteBuffer src, A attachment, CompletionHandler<Integer, ? super A> handler)

Определено в:

write в интерфейсе AsynchronousByteChannel

Параметры типа:

A — Тип прикрепленного объекта

Параметры:

src — Буфер, из которого будут получены байты

attachment — Объект, прикрепляемый к операции ввода-вывода; может быть null

handler — Объект-обработчик завершения

Выбрасывает:

IllegalArgumentException — Если буфер является представлением MemorySegment, выделенного из арены с привязкой к потоку

WritePendingException — Если канал не допускает более одной незавершенной операции записи и предыдущая операция записи еще не завершена

NotYetConnectedException — Если этот канал еще не подключен

ShutdownChannelGroupException — Если работа группы каналов завершена

public abstract Future<Integer> write(ByteBuffer src)

Определено в:

write в интерфейсе AsynchronousByteChannel

Параметры:

src — буфер, из которого извлекаются байты

Возвращает:

Объект Future, представляющий результат операции

Выбрасывает:

IllegalArgumentException — если буфер является представлением MemorySegment, выделенного из арены с ограничением одним потоком

WritePendingException — если канал не допускает более одной незавершённой операции записи и предыдущая операция записи ещё не завершена

NotYetConnectedException — если это соединение ещё не установлено

public abstract <A> void write(ByteBuffer[] srcs, int offset, int length, long timeout, TimeUnit unit, A attachment, CompletionHandler<Long, ? super A> handler)

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

Параметры типа:

A — тип прикреплённого объекта

Параметры:

srcs — буферы, из которых извлекаются байты

offset — смещение в массиве буферов, указывающее на первый буфер, из которого извлекаются байты; должно быть неотрицательным и не превышать srcs.length

length — максимальное количество буферов, к которым будет выполнен доступ; должно быть неотрицательным и не превышать srcs.length - offset

timeout — максимальное время завершения операции ввода-вывода

unit — единица измерения времени для аргумента timeout

attachment — объект, прикрепляемый к операции ввода-вывода; может быть null

handler — обработчик для получения результата

Выбрасывает:

IllegalArgumentException — если какой-либо из буферов является представлением MemorySegment, выделенного из арены с ограничением одним потоком

IndexOutOfBoundsException — если не выполнены предварительные условия для параметров offset и length

WritePendingException — если в этом канале уже выполняется операция записи

NotYetConnectedException — если это соединение ещё не установлено

ShutdownChannelGroupException — если группа каналов завершила работу

public abstract SocketAddress getLocalAddress() throws IOException

Определено в:

getLocalAddress в интерфейсе NetworkChannel

Возвращает:

Объект SocketAddress, к которому привязан сокет; null, если сокет канала не привязан

Выбрасывает:

ClosedChannelException — если канал закрыт

IOException — если произошла ошибка ввода-вывода