IceStorm

Interface _TopicOperationsNC

All Known Subinterfaces:

Topic

All Known Implementing Classes:

_TopicDisp, _TopicTie

public interface _TopicOperationsNC

Publishers publish information on a particular topic. A topic logically represents a type.

See Also:

TopicManager

Method Summary

Modifier and Type	Method and Description
void	destroy() Destroy the topic.
LinkInfo[]	getLinkInfoSeq() Retrieve information on the current links.
java.lang.String	getName() Get the name of this topic.
Ice.ObjectPrx	getNonReplicatedPublisher() Get a non-replicated proxy to a publisher object for this topic.
Ice.ObjectPrx	getPublisher() Get a proxy to a publisher object for this topic.
Ice.Identity[]	getSubscribers() Retrieve the list of subscribers for this topic.
void	link(TopicPrx linkTo, int cost) Create a link to the given topic.
Ice.ObjectPrx	subscribeAndGetPublisher(java.util.Map<java.lang.String,java.lang.String> theQoS, Ice.ObjectPrx subscriber) Subscribe with the given qos to this topic.
void	unlink(TopicPrx linkTo) Destroy the link from this topic to the given topic linkTo.
void	unsubscribe(Ice.ObjectPrx subscriber) Unsubscribe the given subscriber.

Method Detail

getName

java.lang.String getName()

Get the name of this topic.

Returns:

The name of the topic.

See Also:

_TopicManagerOperations.create(java.lang.String, Ice.Current)

getPublisher

Ice.ObjectPrx getPublisher()

Get a proxy to a publisher object for this topic. To publish data to a topic, the publisher calls getPublisher and then casts to the topic type. An unchecked cast must be used on this proxy. If a replicated IceStorm deployment is used this call may return a replicated proxy.

Returns:

A proxy to publish data on this topic.

getNonReplicatedPublisher

Ice.ObjectPrx getNonReplicatedPublisher()

Get a non-replicated proxy to a publisher object for this topic. To publish data to a topic, the publisher calls getPublisher and then casts to the topic type. An unchecked cast must be used on this proxy.

Returns:

A proxy to publish data on this topic.

subscribeAndGetPublisher

Ice.ObjectPrx subscribeAndGetPublisher(java.util.Map<java.lang.String,java.lang.String> theQoS,
                                       Ice.ObjectPrx subscriber)
                                throws AlreadySubscribed,
                                       BadQoS,
                                       InvalidSubscriber

Subscribe with the given qos to this topic. A per-subscriber publisher object is returned.

Parameters:

theQoS - The quality of service parameters for this subscription.

subscriber - The subscriber's proxy.

Returns:

The per-subscriber publisher object.

Throws:

AlreadySubscribed - Raised if the subscriber object is already subscribed.

InvalidSubscriber - Raised if the subscriber object is null.

BadQoS - Raised if the requested quality of service is unavailable or invalid.

See Also:

unsubscribe(Ice.ObjectPrx)

unsubscribe

void unsubscribe(Ice.ObjectPrx subscriber)

Unsubscribe the given subscriber.

Parameters:

subscriber - The proxy of an existing subscriber.

See Also:

subscribeAndGetPublisher(java.util.Map<java.lang.String, java.lang.String>, Ice.ObjectPrx)

link

void link(TopicPrx linkTo,
          int cost)
   throws LinkExists

Create a link to the given topic. All events originating on this topic will also be sent to linkTo.

Parameters:

linkTo - The topic to link to.

cost - The cost to the linked topic.

Throws:

LinkExists - Raised if a link to the same topic already exists.

unlink

void unlink(TopicPrx linkTo)
     throws NoSuchLink

Destroy the link from this topic to the given topic linkTo.

Parameters:

linkTo - The topic to destroy the link to.

Throws:

NoSuchLink - Raised if a link to the topic does not exist.

getLinkInfoSeq

LinkInfo[] getLinkInfoSeq()

Retrieve information on the current links.

Returns:

A sequence of LinkInfo objects.

getSubscribers

Ice.Identity[] getSubscribers()

Retrieve the list of subscribers for this topic.

Returns:

The sequence of Ice identities for the subscriber objects.

destroy

void destroy()

Destroy the topic.