Android - An Open Handset Alliance Project

java.nio.channels
public abstract class

java.nio.channels.ServerSocketChannel

java.lang.Object
	java.nio.channels.spi.AbstractInterruptibleChannel				Channel InterruptibleChannel
		java.nio.channels.SelectableChannel			Channel
			java.nio.channels.spi.AbstractSelectableChannel
				java.nio.channels.ServerSocketChannel

A ServerSocketChannel is a partly abstracted stream-oriented listening socket which is selectable. Binding and manipulation of socket options can only be done through the associated ServerSocket object, returned by calling socket method. ServerSocketChannels can not be constructed for a pre-existing server socket, nor can it be assigned a SocketImpl.

A Server-Socket channel is open but not bound when created by open method. (Calling accept before bound will cause a NotYetBoundException). It can be bound by calling the bind method of a related ServerSocket instance.

Summary

Protected Constructors

					ServerSocketChannel(SelectorProvider selectorProvider)
					Construct a new instance for ServerSocketChannel

Public Methods

abstract			SocketChannel	accept()
				Accepts a connection to this socket.
		static	ServerSocketChannel	open()
				Create an open and unbound server-socket channel.
abstract			ServerSocket	socket()
				Return the related server-socket of this channel.
	final		int	validOps()
				Get the valid operations of this channel.

Methods inherited from class java.nio.channels.spi.AbstractSelectableChannel

blockingLock, configureBlocking, implCloseChannel, implCloseSelectableChannel, implConfigureBlocking, isBlocking, isRegistered, keyFor, provider, register

		final	Object	blockingLock()
				Gets the blocking lock which synchronizes the configureBlocking and register methods.
		final	SelectableChannel	configureBlocking(boolean blockingMode)
				Set the blocking mode of this channel.
	synchronized	final	void	implCloseChannel()
				Implement the closing function.
abstract			void	implCloseSelectableChannel()
				Implement the closing function of the SelectableChannel.
abstract			void	implConfigureBlocking(boolean blockingMode)
				Implement the setting of blocking mode.
		final	boolean	isBlocking()
				Returns if channel is in blocking mode.
	synchronized	final	boolean	isRegistered()
				Returns if channel is registered.
	synchronized	final	SelectionKey	keyFor(Selector selector)
				Gets the selection key for the channel with the given selector.
		final	SelectorProvider	provider()
				Answer the SelectorProvider of this channel.
		final	SelectionKey	register(Selector selector, int interestSet, Object attachment)
				Realize the register function.

	Object	clone()
		Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
	boolean	equals(Object o)
		Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
	void	finalize()
		Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
final	Class	getClass()
		Answers the unique instance of java.lang.Class which represents the class of the receiver.
	int	hashCode()
		Answers an integer hash code for the receiver.
final	void	notify()
		Causes one thread which is `wait` ing on the receiver to be made ready to run.
final	void	notifyAll()
		Causes all threads which are `wait` ing on the receiver to be made ready to run.
	String	toString()
		Answers a string containing a concise, human-readable description of the receiver.
final	void	wait(long time, int frac)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait(long time)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait()
		Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by `notify` or `notifyAll`).

Methods inherited from interface java.io.Closeable

Methods inherited from interface java.nio.channels.InterruptibleChannel

Methods inherited from interface java.nio.channels.Channel

close, isOpen

Details

Protected Constructors

protected ServerSocketChannel(SelectorProvider selectorProvider)

Construct a new instance for ServerSocketChannel

Parameters

selectorProvider	An instance of SelectorProvider

Public Methods

public abstract SocketChannel accept()

Accepts a connection to this socket.

It returns null when the channel is non-blocking and no connections available, otherwise it blocks indefinitely until a new connection is available or an I/O error occurs. The returned channel will be in blocking mode any way.

This method just execute the same security checks as the accept method of the ServerSocket class.

Returns

The accepted SocketChannel instance, or null as the channel is non-blocking and no connections available.

Throws

ClosedChannelException	If the channel is already closed.
AsynchronousCloseException	If the channel is closed by another thread while this method is in operation.
ClosedByInterruptException	If another thread interrupts the calling thread while the operation is in progress. The calling thread will have the interrupt state set, and the channel will be closed.
NotYetBoundException	If the socket has not yet been bound.
SecurityException	If there is a security manager, and the new connection is not permitted to access.
IOException	Some other IO error occurred.

public static ServerSocketChannel open()

Create an open and unbound server-socket channel.

This channel is got by calling openServerSocketChannel method of the default SelectorProvider instance.

Returns

The new created channel which is open but unbound.

Throws

IOException	If some IO problem occurs.

public abstract ServerSocket socket()

Return the related server-socket of this channel. All public methods declared in returned object should be declared in ServerSocket.

Returns

The related ServerSocket instance.

public final int validOps()

Get the valid operations of this channel. Server-socket channels support accepting operation.Currently the only supported operation is OP_ACCEPT. It always returns SelectionKey.OP_ACCEPT.

Returns

Valid operations in bit-set.

				void	close()
					Closes an open channel.
				boolean	isOpen()
					Answers whether this channel is open or not.

Android - An Open Handset Alliance Project

Documentation

Goodies

java.nio.channels.ServerSocketChannel

Summary

Protected Constructors

Public Methods

Methods inherited from class java.nio.channels.spi.AbstractSelectableChannel

Methods inherited from class java.nio.channels.SelectableChannel

Methods inherited from class java.nio.channels.spi.AbstractInterruptibleChannel

Methods inherited from class java.lang.Object

Methods inherited from interface java.io.Closeable

Methods inherited from interface java.nio.channels.InterruptibleChannel

Methods inherited from interface java.nio.channels.Channel

Details

Protected Constructors

protected ServerSocketChannel(SelectorProvider selectorProvider)

Parameters

Public Methods

public abstract SocketChannel accept()

Returns

Throws

public static ServerSocketChannel open()

Returns

Throws

public abstract ServerSocket socket()

Returns

public final int validOps()

Returns

See Also

		final	void	begin()
				Start an IO operation that is potentially blocking.
		final	void	close()
				Closes the channel.
		final	void	end(boolean success)
				End an IO operation that was previously started with `begin()`.
abstract			void	implCloseChannel()
				Implements the close channel behavior.
	synchronized	final	boolean	isOpen()
				Answers whether the channel is open.

				void	close()
					Close the object and release any system resources it holds.


e.g. "intent" or "activity"