Package com.tangosol.net.topic

Class Subscriber.Name<V>

java.lang.Object

com.tangosol.net.topic.Subscriber.Name<V>

All Implemented Interfaces:

ExternalizableLite, PortableObject, Subscriber.Option<V,V>, Serializable

Enclosing interface:

Subscriber<V>

public static class Subscriber.Name<V>
extends Object
implements Subscriber.Option<V,V>, ExternalizableLite, PortableObject

The Name option is used to specify a subscriber group name.

Providing a group name allows multiple subscriber instances to share the responsibility for processing the contents of the group's durable subscription. Each item added to the durable subscription will only be received by one member of the group, whereas each distinct subscriber group for the topic will see every added item.

Naming a subscriber also allows it to outlive its subscriber instances. For example a group can be created, all instances can terminate and then later be recreated and pickup exactly where they left off in the topic. As the group's life is independent of its subscriber instances the group must be explicitly destroyed in order to have the topic stop retaining values for it.

If the Subscriber.Name option is not specified then the subscriber will be part of an anonymous group populated by no other members and will thus be ensured to see the full contents of the topic and automatically destroyed upon being closed, or when the Coherence member terminates.

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.tangosol.net.topic.Subscriber.Option

NULL_OPTION

Constructor Summary

Constructors

Modifier	Constructor	Description
	Name()	Default constructor for serialization.
protected	Name(String sName)	Construct a new group name.

Method Summary

Modifier and Type	Method	Description
String	getName()	Return the group name.
static <V> Subscriber.Name<V>	inGroup(String sName)	Obtain a Subscriber.Option that specifies a group name for a Subscriber.
static <V> Subscriber.Name<V>	of(String sName)	Obtain a Subscriber.Option that specifies a group name for a Subscriber.
void	readExternal(PofReader in)	Restore the contents of a user type instance by reading its state using the specified PofReader object.
void	readExternal(DataInput in)	Restore the contents of this object by loading the object's state from the passed DataInput object.
void	writeExternal(PofWriter out)	Save the contents of a POF user type instance by writing its state using the specified PofWriter object.
void	writeExternal(DataOutput out)	Save the contents of this object by storing the object's state into the passed DataOutput object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Name

public Name()

Default constructor for serialization.

Name

protected Name(String sName)

Construct a new group name.

Parameters:

sName - the group name

Method Detail

of

public static <V> Subscriber.Name<V> of(String sName)

Obtain a Subscriber.Option that specifies a group name for a Subscriber.

Parameters:

sName - the group name to use for the {Link Subscriber}.

Returns:

a Subscriber.Option that specifies a group name for a Subscriber

inGroup

public static <V> Subscriber.Name<V> inGroup(String sName)

Obtain a Subscriber.Option that specifies a group name for a Subscriber.

Parameters:

sName - the group name to use for the {Link Subscriber}.

Returns:

a Subscriber.Option that specifies a group name for a Subscriber

getName

public String getName()

Return the group name.

Returns:

the group name

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