Package com.zeroc.IceStorm
Interface Topic
- All Superinterfaces:
Object
Publishers publish information on a particular topic. A topic
logically represents a type.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface com.zeroc.Ice.Object
Object.Ice_invokeResult
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Destroy the topic.LinkInfo[]
getLinkInfoSeq
(Current current) Retrieve information on the current links.Get the name of this topic.getNonReplicatedPublisher
(Current current) Get a non-replicated proxy to a publisher object for this topic.getPublisher
(Current current) Get a proxy to a publisher object for this topic.Identity[]
getSubscribers
(Current current) Retrieve the list of subscribers for this topic.default String
Returns the Slice type ID of the most-derived interface supported by this object.default String[]
Returns the Slice type IDs of the interfaces supported by this object.static String
Returns the Slice type ID of the interface supported by this object.void
Create a link to the given topic.Subscribe with the givenqos
to this topic.void
Destroy the link from this topic to the given topiclinkTo
.void
unsubscribe
(ObjectPrx subscriber, Current current) Unsubscribe the givensubscriber
.Methods inherited from interface com.zeroc.Ice.Object
ice_dispatch, ice_isA, ice_ping
-
Method Details
-
getName
Get the name of this topic.- Parameters:
current
- The Current object for the invocation.- Returns:
- The name of the topic.
- See Also:
-
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.- Parameters:
current
- The Current object for the invocation.- Returns:
- A proxy to publish data on this topic.
-
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.- Parameters:
current
- The Current object for the invocation.- Returns:
- A proxy to publish data on this topic.
-
subscribeAndGetPublisher
ObjectPrx subscribeAndGetPublisher(Map<String, String> theQoS, ObjectPrx subscriber, Current current) throws AlreadySubscribed, BadQoS, InvalidSubscriberSubscribe with the givenqos
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.BadQoS
- Raised if the requested quality of service is unavailable or invalid.InvalidSubscriber
- Raised if the subscriber object is null.- See Also:
-
unsubscribe
Unsubscribe the givensubscriber
.- Parameters:
subscriber
- The proxy of an existing subscriber.current
- The Current object for the invocation.- See Also:
-
link
Create a link to the given topic. All events originating on this topic will also be sent tolinkTo
.- 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
Destroy the link from this topic to the given topiclinkTo
.- 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
Retrieve information on the current links.- Parameters:
current
- The Current object for the invocation.- Returns:
- A sequence of LinkInfo objects.
-
getSubscribers
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
Destroy the topic.- Parameters:
current
- The Current object for the invocation.
-
ice_ids
Description copied from interface:Object
Returns the Slice type IDs of the interfaces supported by this object. -
ice_id
Description copied from interface:Object
Returns the Slice type ID of the most-derived interface supported by this object. -
ice_staticId
Description copied from interface:Object
Returns the Slice type ID of the interface supported by this object.- Returns:
- The return value is always ::Ice::Object.
-