Package com.tangosol.net

Class CompositeAddressProvider.SingleProvider

java.lang.Object

com.tangosol.net.CompositeAddressProvider.SingleProvider

All Implemented Interfaces:

AddressProvider, SocketAddressProvider

Enclosing class:

CompositeAddressProvider

protected class CompositeAddressProvider.SingleProvider
extends Object
implements AddressProvider

AddressProvider wrapper for a single address dynamically added to this AddressSet.

Field Summary

Fields

Modifier and Type	Field	Description
protected InetSocketAddress	m_address	The single address that this AddressProvider represents.
protected boolean	m_fExhausted	Is this AddressProvider exhausted?

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SingleProvider(InetSocketAddress address)	Constructor

Method Summary

Modifier and Type	Method	Description
void	accept()	This method should be called by the client immediately after it determines that it can successfully use an address returned by the SocketAddressProvider.getNextAddress() method.
boolean	equals(Object o)	SocketAddressProvider instances are considered equivalent iff they consistently produce the same resulting set of addresses.
InetSocketAddress	getNextAddress()	Covariant of SocketAddressProvider.getNextAddress() which returns an InetSocketAddress.
int	hashCode()	Return the hash code for this SocketAddressProvider.
void	reject(Throwable eCause)	This method should be called by the client immediately after it determines that an attempt to use an address returned by the SocketAddressProvider.getNextAddress() method has failed.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

m_address

protected InetSocketAddress m_address

The single address that this AddressProvider represents.

m_fExhausted

protected boolean m_fExhausted

Is this AddressProvider exhausted?

Constructor Detail

SingleProvider

protected SingleProvider(InetSocketAddress address)

Constructor

Method Detail

getNextAddress

public InetSocketAddress getNextAddress()

Covariant of SocketAddressProvider.getNextAddress() which returns an InetSocketAddress.

Specified by:

getNextAddress in interface AddressProvider

Specified by:

getNextAddress in interface SocketAddressProvider

Returns:

the next available address or null if the list of available addresses was exhausted

accept

public void accept()

This method should be called by the client immediately after it determines that it can successfully use an address returned by the SocketAddressProvider.getNextAddress() method.

Specified by:

accept in interface SocketAddressProvider

reject

public void reject(Throwable eCause)

This method should be called by the client immediately after it determines that an attempt to use an address returned by the SocketAddressProvider.getNextAddress() method has failed.

Specified by:

reject in interface SocketAddressProvider

Parameters:

eCause - (optional) an exception that carries the reason why the the caller rejected the previously returned address

equals

public boolean equals(Object o)

SocketAddressProvider instances are considered equivalent iff they consistently produce the same resulting set of addresses.

Note: the general contract of hashCode and equals() should be preserved; AddressProviders that are "equal" should produce the same hashCode.

Specified by:

equals in interface SocketAddressProvider

Overrides:

equals in class Object

Parameters:

o - the Object to compare this SocketAddressProvider to for equality

Returns:

true iff this SocketAddressProvider is equal to the specified object

hashCode

public int hashCode()

Return the hash code for this SocketAddressProvider.

Specified by:

hashCode in interface SocketAddressProvider

Overrides:

hashCode in class Object

Returns:

the hash code for this SocketAddressProvider