com.solacesystems.solclientj.core.handle

Interface MessageDispatchTargetHandle

All Superinterfaces:

Handle, MessageSupport

public interface MessageDispatchTargetHandle
extends Handle, MessageSupport

The MessageDispatchTargetHandle interface allows an application to receive messages on a specific Subscription. Applications that need this interface must instantiate an object with the MessageDispatchTargetHandle interface by calling Solclient.Allocator.newMessageDispatchTargetHandle().

The allocated MessageDispatchTargetHandle is used to create a subscription entry in the API by calling SessionHandle.subscribe() or FlowHandle.subscribe()

Method Summary

Modifier and Type	Method and Description
void	destroy() This method will destroy the the message dispatch associated with this instance.
MessageCallback	getMessageCallback()
Subscription	getSubscription()
boolean	isLocalDispatchOnly() The Local Dispatch Only attribute can be set on MessageDispatchTargetHandle when the object is created.

Methods inherited from interface com.solacesystems.solclientj.core.handle.Handle

isBound

Methods inherited from interface com.solacesystems.solclientj.core.handle.MessageSupport

getRxMessage, takeRxMessage

Method Detail

getSubscription

Subscription getSubscription()

Returns:

the Subscription (Subscription) set in the MessageDispatchTargetHandle object with Solclient.Allocator.newMessageDispatchTargetHandle()

getMessageCallback

MessageCallback getMessageCallback()

Returns:

the registered MessageCallback set in the MessageDispatchTargetHandle object with Solclient.Allocator.newMessageDispatchTargetHandle()

isLocalDispatchOnly

boolean isLocalDispatchOnly()

The Local Dispatch Only attribute can be set on MessageDispatchTargetHandle when the object is created. By setting this attribute, the Subscription is not sent to the appliance and exists only in the local API dispatch table. This can serve to reduce the resource use on the appliance in the network of appliances.

For this to have any affect at all, an encompassing Subscription must be set on the appliance. For example, an application could send the subscription /foo/> to the appliance and this subscription will be propogated through the network. Then the application could add 'Local Dispatch Only' subscriptions for /foo/1, /foo/2, and /foo/3. Messages on all these topics would be delivered to the application due to the wild card subscription. They would then be dispatched to the individual MessageDispatchTargetHandle by the Local Dispatch Only entries.

Returns:

true or false. The Local Dispatch Only attribute is set when the object is created with Solclient.Allocator.newMessageDispatchTargetHandle()

destroy

void destroy()
      throws SolclientException

This method will destroy the the message dispatch associated with this instance. The message dispatch is bound to the Handle by a subscribe() operation. This is exactly the same as calling unsubscribe(in_outHandle, 0, 0); In many cases it is preferable to call unsubscribe() as it make the code easier to understand, and allows the application to set both flags, and correlation key.

Specified by:

destroy in interface Handle

Throws:

SolclientException - if the destroy fails