Skip navigation links

com.tangosol.net
Class WrapperSocketProvider

java.lang.Object
java.nio.channels.spi.SelectorProvider
com.tangosol.net.WrapperSocketProvider

All Implemented Interfaces:

SocketProvider, XmlConfigurable

Direct Known Subclasses:

TcpSocketProvider

public abstract class WrapperSocketProvider

extends SelectorProvider

implements SocketProvider, XmlConfigurable

WrapperSocketProvider is a SocketProvider which produces wrapped sockets which are obtained from a delegate SocketProvider.

Since:

Coherence 3.6

Author:

mf 2010.05.19

Field Summary

protected SocketProviderFactory	m_factory The associated factory.
protected XmlElement	m_xml The configuration supplied to the provider.

Constructor Summary

protected	WrapperSocketProvider() Construct a WrapperSocketProvider with no delegate, allowing the delegate to be specified programatically or through configuration.
	WrapperSocketProvider(SocketProvider provider) Construct a WrapperSocketProvider which delegates all SocketProvider calls to the delegate.

Method Summary

SocketProvider	ensureDelegate() Return the delegate SocketProvider, creating one if necessary.
XmlElement	getConfig() Determine the current configuration of the object.
SocketProvider	getDelegate() Return the delegate SocketProvider.
SocketProviderFactory	getFactory() Return the factory associated with this provider.
Channel	inheritedChannel() Unsupported.
DatagramChannel	openDatagramChannel() Return a new DatagramChannel.
DatagramSocket	openDatagramSocket() Return a new DatagramSocket.
MulticastSocket	openMulticastSocket() Return a new MulticastSocket.
Pipe	openPipe() Unsupported.
AbstractSelector	openSelector()
ServerSocket	openServerSocket() Return a new ServerSocket.
ServerSocketChannel	openServerSocketChannel() Return a new ServerSocketChannel.
Socket	openSocket() Return a new Socket.
SocketChannel	openSocketChannel() Return a new SocketChannel.
void	setConfig(XmlElement xml) Specify the configuration for the object.
void	setDelegate(SocketProvider provider) Set the delegate SocketProvider
void	setFactory(SocketProviderFactory factory) Specify the SocketProviderFactory associated with this provider.

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

provider

Field Detail

m_factory

protected SocketProviderFactory m_factory

The associated factory.

m_xml

protected XmlElement m_xml

The configuration supplied to the provider.

Constructor Detail

WrapperSocketProvider

public WrapperSocketProvider(SocketProvider provider)

Construct a WrapperSocketProvider which delegates all SocketProvider calls to the delegate.

Parameters:

provider - the delegate provider

WrapperSocketProvider

protected WrapperSocketProvider()

Construct a WrapperSocketProvider with no delegate, allowing the delegate to be specified programatically or through configuration.

Method Detail

setDelegate

public void setDelegate(SocketProvider provider)

Set the delegate SocketProvider

Parameters:

provider - the delegate provider

Throws:

IllegalStateException - if a provider has already been configured

getDelegate

public SocketProvider getDelegate()

Return the delegate SocketProvider.

Returns:

the delegate SocketProvider

ensureDelegate

public SocketProvider ensureDelegate()
                              throws IOException

Return the delegate SocketProvider, creating one if necessary.

Returns:

the delegate SocketProvider

Throws:

IOException - if an I/O error occurs

openSocket

public Socket openSocket()
                  throws IOException

Return a new Socket.

Specified by:

openSocket in interface SocketProvider

Returns:

the Socket

Throws:

IOException - if an I/O related error occurs

openSocketChannel

public SocketChannel openSocketChannel()
                                throws IOException

Return a new SocketChannel.

Specified by:

openSocketChannel in interface SocketProvider

Specified by:

openSocketChannel in class SelectorProvider

Returns:

the connected SocketChannel

Throws:

IOException - if an I/O related error occurs

openServerSocket

public ServerSocket openServerSocket()
                              throws IOException

Return a new ServerSocket.

Specified by:

openServerSocket in interface SocketProvider

Returns:

the ServerSocket

Throws:

IOException - if an I/O related error occurs

openServerSocketChannel

public ServerSocketChannel openServerSocketChannel()
                                            throws IOException

Return a new ServerSocketChannel.

Specified by:

openServerSocketChannel in interface SocketProvider

Specified by:

openServerSocketChannel in class SelectorProvider

Returns:

the ServerSocketChannel

Throws:

IOException - if an I/O related error occurs

openDatagramSocket

public DatagramSocket openDatagramSocket()
                                  throws IOException

Return a new DatagramSocket.

Specified by:

openDatagramSocket in interface SocketProvider

Returns:

the DatagramSocket

Throws:

IOException - if an I/O related error occurs

openDatagramChannel

public DatagramChannel openDatagramChannel()
                                    throws IOException

Return a new DatagramChannel.

Specified by:

openDatagramChannel in interface SocketProvider

Specified by:

openDatagramChannel in class SelectorProvider

Returns:

the DatagramChannel

Throws:

IOException - if an I/O related error occurs

openMulticastSocket

public MulticastSocket openMulticastSocket()
                                    throws IOException

Return a new MulticastSocket.

Specified by:

openMulticastSocket in interface SocketProvider

Returns:

the MulticastSocket

Throws:

IOException - if an I/O related error occurs

setFactory

public void setFactory(SocketProviderFactory factory)

Specify the SocketProviderFactory associated with this provider.

Specified by:

setFactory in interface SocketProvider

Parameters:

factory - the associated factory

getFactory

public SocketProviderFactory getFactory()

Return the factory associated with this provider.

Specified by:

getFactory in interface SocketProvider

Returns:

the associated factory

openSelector

public AbstractSelector openSelector()
                              throws IOException

Specified by:

openSelector in class SelectorProvider

Throws:

IOException

openPipe

public Pipe openPipe()
              throws IOException

Unsupported.

Specified by:

openPipe in class SelectorProvider

Throws:

UnsupportedOperationException

IOException

inheritedChannel

public Channel inheritedChannel()
                         throws IOException

Unsupported.

Overrides:

inheritedChannel in class SelectorProvider

Throws:

UnsupportedOperationException

IOException

getConfig

public XmlElement getConfig()

Determine the current configuration of the object.

Specified by:

getConfig in interface XmlConfigurable

Returns:

the XML configuration or null

setConfig

public void setConfig(XmlElement xml)

Specify the configuration for the object.

Specified by:

setConfig in interface XmlConfigurable

Parameters:

xml - the XML configuration for the object

Skip navigation links