-
- All Superinterfaces:
- AutoCloseable, Channel, Closeable
- All Known Subinterfaces:
- MulticastChannel
- All Known Implementing Classes:
- AsynchronousServerSocketChannel, AsynchronousSocketChannel, DatagramChannel, ServerSocketChannel, SocketChannel
public interface NetworkChannel extends Channel
A channel to a network socket.A channel that implements this interface is a channel to a network socket. The
bindmethod is used to bind the socket to a localaddress, thegetLocalAddressmethod returns the address that the socket is bound to, and thesetOptionandgetOptionmethods are used to set and query socket options. An implementation of this interface should specify the socket options that it supports.The
bindandsetOptionmethods that do not otherwise have a value to return are specified to return the network channel upon which they are invoked. This allows method invocations to be chained. Implementations of this interface should specialize the return type so that method invocations on the implementation class can be chained.- Since:
- 1.7
-
-
Method Summary
Methods Modifier and Type Method and Description NetworkChannelbind(SocketAddress local)Binds the channel's socket to a local address.SocketAddressgetLocalAddress()Returns the socket address that this channel's socket is bound to, ornullif the socket is not bound.<T> TgetOption(SocketOption<T> name)Returns the value of a socket option.<T> NetworkChannelsetOption(SocketOption<T> name, T value)Sets the value of a socket option.Set<SocketOption<?>>supportedOptions()Returns a set of the socket options supported by this channel.
-
-
-
Method Detail
-
bind
NetworkChannel bind(SocketAddress local) throws IOException
Binds the channel's socket to a local address.This method is used to establish an association between the socket and a local address. Once an association is established then the socket remains bound until the channel is closed. If the
localparameter has the valuenullthen the socket will be bound to an address that is assigned automatically.- Parameters:
local- The address to bind the socket, ornullto bind the socket to an automatically assigned socket address- Returns:
- This channel
- Throws:
AlreadyBoundException- If the socket is already boundUnsupportedAddressTypeException- If the type of the given address is not supportedClosedChannelException- If the channel is closedIOException- If some other I/O error occursSecurityException- If a security manager is installed and it denies an unspecified permission. An implementation of this interface should specify any required permissions.- See Also:
getLocalAddress()
-
getLocalAddress
SocketAddress getLocalAddress() throws IOException
Returns the socket address that this channel's socket is bound to, ornullif the socket is not bound.Where the channel is
boundto an Internet Protocol socket address then the return value from this method is of typeInetSocketAddress.- Returns:
- The socket address that the socket is bound to, or
nullif the channel's socket is not bound - Throws:
ClosedChannelException- If the channel is closedIOException- If an I/O error occurs
-
setOption
<T> NetworkChannel setOption(SocketOption<T> name, T value) throws IOException
Sets the value of a socket option.- Parameters:
name- The socket optionvalue- The value of the socket option. A value ofnullmay be a valid value for some socket options.- Returns:
- This channel
- Throws:
UnsupportedOperationException- If the socket option is not supported by this channelIllegalArgumentException- If the value is not a valid value for this socket optionClosedChannelException- If this channel is closedIOException- If an I/O error occurs- See Also:
StandardSocketOptions
-
getOption
<T> T getOption(SocketOption<T> name) throws IOException
Returns the value of a socket option.- Parameters:
name- The socket option- Returns:
- The value of the socket option. A value of
nullmay be a valid value for some socket options. - Throws:
UnsupportedOperationException- If the socket option is not supported by this channelClosedChannelException- If this channel is closedIOException- If an I/O error occurs- See Also:
StandardSocketOptions
-
supportedOptions
Set<SocketOption<?>> supportedOptions()
Returns a set of the socket options supported by this channel.This method will continue to return the set of options even after the channel has been closed.
- Returns:
- A set of the socket options supported by this channel
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/nio/channels/NetworkChannel.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.
