com.solacesystems.solclientj.core.event

Interface MessageDispatcher

All Known Subinterfaces:

FlowHandle, SessionHandle

public interface MessageDispatcher

Interface to add a per topic MessageCallback to a SessionHandle or FlowHandle

Method Summary

Modifier and Type	Method and Description
int	subscribe(MessageDispatchTargetHandle in_out_msgDispatchTargetHandle, int flags, long correlationKey)
int	subscribe(MutableMessageDispatchTargetHandle in_out_mutableMessageDispatchTargetHandle, MutableTopic subscription, MessageCallback messagecallback, boolean isLocalDispatchOnly, int flags, long correlationKey)
int	unsubscribe(MessageDispatchTargetHandle in_out_msgDispatchTargetHandle, int flags, long correlationKey)
int	unsubscribe(MutableMessageDispatchTargetHandle in_out_mutableMessageDispatchTargetHandle, int flags, long correlationKey)

Method Detail

subscribe

int subscribe(MessageDispatchTargetHandle in_out_msgDispatchTargetHandle,
              int flags,
              long correlationKey)
       throws SolclientException

Parameters:

in_out_msgDispatchTargetHandle - An unbound MessageDispatchTargetHandle

flags - SolEnum.SubscribeFlags

correlationKey - integer

Returns:

SolEnum.ReturnCode

Throws:

SolclientException

java.lang.IllegalArgumentException - if the MessageDispatchTargetHandle is not a usable unbound handle.

unsubscribe

int unsubscribe(MessageDispatchTargetHandle in_out_msgDispatchTargetHandle,
                int flags,
                long correlationKey)
         throws SolclientException

Parameters:

in_out_msgDispatchTargetHandle - A bound MessageDispatchTargetHandle

flags - SolEnum.SubscribeFlags

correlationKey - integer

Returns:

SolEnum.ReturnCode

Throws:

SolclientException

java.lang.IllegalArgumentException - if the MessageDispatchTargetHandle is not a usable bound handle.

subscribe

int subscribe(MutableMessageDispatchTargetHandle in_out_mutableMessageDispatchTargetHandle,
              MutableTopic subscription,
              MessageCallback messagecallback,
              boolean isLocalDispatchOnly,
              int flags,
              long correlationKey)
       throws SolclientException

Parameters:

in_out_mutableMessageDispatchTargetHandle - An unbound MutableMessageDispatchTargetHandle

subscription - MutableTopic

messagecallback - MessageCallback

isLocalDispatchOnly - indicates if this Dispatch target is for Local delivery only.

flags - SolEnum.SubscribeFlags

correlationKey - integer

Returns:

SolEnum.ReturnCode

Throws:

SolclientException

java.lang.IllegalArgumentException - if the MutableMessageDispatchTargetHandle is not a usable unbound handle.

unsubscribe

int unsubscribe(MutableMessageDispatchTargetHandle in_out_mutableMessageDispatchTargetHandle,
                int flags,
                long correlationKey)
         throws SolclientException

Parameters:

in_out_mutableMessageDispatchTargetHandle - A bound MutableMessageDispatchTargetHandle

flags - SolEnum.SubscribeFlags

correlationKey - integer

Returns:

SolEnum.ReturnCode

Throws:

SolclientException

java.lang.IllegalArgumentException - if the MutableMessageDispatchTargetHandle is not a usable bound handle.