IceStorm

Interface _TopicOperations

All Known Subinterfaces:

Topic

All Known Implementing Classes:

_TopicDisp, _TopicTie

public interface _TopicOperations

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

Method Detail

getName

java.lang.String getName(Ice.Current __current)

Get the name of this topic.

Parameters:

__current - The Current object for the invocation.

Returns:

The name of the topic.

See Also:

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

getPublisher

Ice.ObjectPrx getPublisher(Ice.Current __current)

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.

Parameters:

__current - The Current object for the invocation.

Returns:

A proxy to publish data on this topic.

getNonReplicatedPublisher

Ice.ObjectPrx getNonReplicatedPublisher(Ice.Current __current)

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.

Parameters:

__current - The Current object for the invocation.

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,
                                       Ice.Current __current)
                                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.

__current - The Current object for the invocation.

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, Ice.Current)

unsubscribe

void unsubscribe(Ice.ObjectPrx subscriber,
                 Ice.Current __current)

Unsubscribe the given subscriber.

Parameters:

subscriber - The proxy of an existing subscriber.

__current - The Current object for the invocation.

See Also:

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

link

void link(TopicPrx linkTo,
          int cost,
          Ice.Current __current)
   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.

__current - The Current object for the invocation.

Throws:

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

unlink

void unlink(TopicPrx linkTo,
            Ice.Current __current)
     throws NoSuchLink

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

Parameters:

linkTo - The topic to destroy the link to.

__current - The Current object for the invocation.

Throws:

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

getLinkInfoSeq

LinkInfo[] getLinkInfoSeq(Ice.Current __current)

Retrieve information on the current links.

Parameters:

__current - The Current object for the invocation.

Returns:

A sequence of LinkInfo objects.

getSubscribers

Ice.Identity[] getSubscribers(Ice.Current __current)

Retrieve the list of subscribers for this topic.

Parameters:

__current - The Current object for the invocation.

Returns:

The sequence of Ice identities for the subscriber objects.

destroy

void destroy(Ice.Current __current)

Destroy the topic.

Parameters:

__current - The Current object for the invocation.