Skip to content

Most visited

Recently visited

navigation
Added in API level 1

SelectorProvider

public abstract class SelectorProvider
extends Object

java.lang.Object
   ↳ java.nio.channels.spi.SelectorProvider


Service-provider class for selectors and selectable channels.

A selector provider is a concrete subclass of this class that has a zero-argument constructor and implements the abstract methods specified below. A given invocation of the Java virtual machine maintains a single system-wide default provider instance, which is returned by the provider method. The first invocation of that method will locate the default provider as specified below.

The system-wide default provider is used by the static open methods of the DatagramChannel, Pipe, Selector, ServerSocketChannel, and SocketChannel classes. It is also used by the System.inheritedChannel() method. A program may make use of a provider other than the default provider by instantiating that provider and then directly invoking the open methods defined in this class.

All of the methods in this class are safe for use by multiple concurrent threads.

Summary

Protected constructors

SelectorProvider()

Initializes a new instance of this class.

Public methods

Channel inheritedChannel()

Returns the channel inherited from the entity that created this Java virtual machine.

abstract DatagramChannel openDatagramChannel(ProtocolFamily family)

Opens a datagram channel.

abstract DatagramChannel openDatagramChannel()

Opens a datagram channel.

abstract Pipe openPipe()

Opens a pipe.

abstract AbstractSelector openSelector()

Opens a selector.

abstract ServerSocketChannel openServerSocketChannel()

Opens a server-socket channel.

abstract SocketChannel openSocketChannel()

Opens a socket channel.

static SelectorProvider provider()

Returns the system-wide default selector provider for this invocation of the Java virtual machine.

Inherited methods

From class java.lang.Object

Protected constructors

SelectorProvider

Added in API level 1
SelectorProvider ()

Initializes a new instance of this class.

Throws
SecurityException If a security manager has been installed and it denies RuntimePermission("selectorProvider")

Public methods

inheritedChannel

Added in API level 1
Channel inheritedChannel ()

Returns the channel inherited from the entity that created this Java virtual machine.

On many operating systems a process, such as a Java virtual machine, can be started in a manner that allows the process to inherit a channel from the entity that created the process. The manner in which this is done is system dependent, as are the possible entities to which the channel may be connected. For example, on UNIX systems, the Internet services daemon (inetd) is used to start programs to service requests when a request arrives on an associated network port. In this example, the process that is started, inherits a channel representing a network socket.

In cases where the inherited channel represents a network socket then the Channel type returned by this method is determined as follows:

  • If the inherited channel represents a stream-oriented connected socket then a SocketChannel is returned. The socket channel is, at least initially, in blocking mode, bound to a socket address, and connected to a peer.

  • If the inherited channel represents a stream-oriented listening socket then a ServerSocketChannel is returned. The server-socket channel is, at least initially, in blocking mode, and bound to a socket address.

  • If the inherited channel is a datagram-oriented socket then a DatagramChannel is returned. The datagram channel is, at least initially, in blocking mode, and bound to a socket address.

In addition to the network-oriented channels described, this method may return other kinds of channels in the future.

The first invocation of this method creates the channel that is returned. Subsequent invocations of this method return the same channel.

Returns
Channel The inherited channel, if any, otherwise null.
Throws
IOException If an I/O error occurs
SecurityException If a security manager has been installed and it denies RuntimePermission("inheritedChannel")

openDatagramChannel

Added in API level 24
DatagramChannel openDatagramChannel (ProtocolFamily family)

Opens a datagram channel.

Parameters
family ProtocolFamily: The protocol family
Returns
DatagramChannel A new datagram channel
Throws
UnsupportedOperationException If the specified protocol family is not supported
IOException If an I/O error occurs

openDatagramChannel

Added in API level 1
DatagramChannel openDatagramChannel ()

Opens a datagram channel.

Returns
DatagramChannel The new channel
Throws
IOException

openPipe

Added in API level 1
Pipe openPipe ()

Opens a pipe.

Returns
Pipe The new pipe
Throws
IOException

openSelector

Added in API level 1
AbstractSelector openSelector ()

Opens a selector.

Returns
AbstractSelector The new selector
Throws
IOException

openServerSocketChannel

Added in API level 1
ServerSocketChannel openServerSocketChannel ()

Opens a server-socket channel.

Returns
ServerSocketChannel The new channel
Throws
IOException

openSocketChannel

Added in API level 1
SocketChannel openSocketChannel ()

Opens a socket channel.

Returns
SocketChannel The new channel
Throws
IOException

provider

Added in API level 1
SelectorProvider provider ()

Returns the system-wide default selector provider for this invocation of the Java virtual machine.

The first invocation of this method locates the default provider object as follows:

  1. If the system property java.nio.channels.spi.SelectorProvider is defined then it is taken to be the fully-qualified name of a concrete provider class. The class is loaded and instantiated; if this process fails then an unspecified error is thrown.

  2. If a provider class has been installed in a jar file that is visible to the system class loader, and that jar file contains a provider-configuration file named java.nio.channels.spi.SelectorProvider in the resource directory META-INF/services, then the first class name specified in that file is taken. The class is loaded and instantiated; if this process fails then an unspecified error is thrown.

  3. Finally, if no provider has been specified by any of the above means then the system-default provider class is instantiated and the result is returned.

Subsequent invocations of this method return the provider that was returned by the first invocation.

Returns
SelectorProvider The system-wide default selector provider
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.