com.tangosol.net.topic

Class Publisher.FailOnFull

java.lang.Object

com.tangosol.net.topic.Publisher.FailOnFull

All Implemented Interfaces:

ExternalizableLite, PortableObject, Publisher.Option<Object>, Serializable

Enclosing interface:

Publisher<V>

public static class Publisher.FailOnFull
extends Object
implements Publisher.Option<Object>, ExternalizableLite, PortableObject

The FailOnFull option indicates that the CompletableFuture returned from the Publisher.send(V) operation should complete exceptionally upon identifying that the topic is or has become full. Without this option the future will not complete until more space becomes available.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static Publisher.FailOnFull	INSTANCE Singleton instance.

Constructor Summary

Constructors

Constructor and Description
FailOnFull() Default constructor for serialization.

Method Summary

Modifier and Type	Method and Description
static Publisher.FailOnFull	enabled() Obtain the Option indicating futures should complete exceptionally if the topic is full.
void	readExternal(DataInput in) Restore the contents of this object by loading the object's state from the passed DataInput object.
void	readExternal(PofReader in) Restore the contents of a user type instance by reading its state using the specified PofReader object.
void	writeExternal(DataOutput out) Save the contents of this object by storing the object's state into the passed DataOutput object.
void	writeExternal(PofWriter out) Save the contents of a POF user type instance by writing its state using the specified PofWriter object.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

protected static final Publisher.FailOnFull INSTANCE

Singleton instance.

Constructor Detail

FailOnFull

public FailOnFull()

Default constructor for serialization.

Method Detail

readExternal

public void readExternal(DataInput in)
                  throws IOException

Description copied from interface: ExternalizableLite

Restore the contents of this object by loading the object's state from the passed DataInput object.

Specified by:

readExternal in interface ExternalizableLite

Parameters:

in - the DataInput stream to read data from in order to restore the state of this object

Throws:

IOException - if an I/O exception occurs

NotActiveException - if the object is not in its initial state, and therefore cannot be deserialized into

writeExternal

public void writeExternal(DataOutput out)
                   throws IOException

Description copied from interface: ExternalizableLite

Save the contents of this object by storing the object's state into the passed DataOutput object.

Specified by:

writeExternal in interface ExternalizableLite

Parameters:

out - the DataOutput stream to write the state of this object to

Throws:

IOException - if an I/O exception occurs

readExternal

public void readExternal(PofReader in)
                  throws IOException

Description copied from interface: PortableObject

Restore the contents of a user type instance by reading its state using the specified PofReader object.

Specified by:

readExternal in interface PortableObject

Parameters:

in - the PofReader from which to read the object's state

Throws:

IOException - if an I/O error occurs

writeExternal

public void writeExternal(PofWriter out)
                   throws IOException

Description copied from interface: PortableObject

Save the contents of a POF user type instance by writing its state using the specified PofWriter object.

Specified by:

writeExternal in interface PortableObject

Parameters:

out - the PofWriter to which to write the object's state

Throws:

IOException - if an I/O error occurs

enabled

public static Publisher.FailOnFull enabled()

Obtain the Option indicating futures should complete exceptionally if the topic is full.

Returns:

the option