com.solacesystems.solclientj.core.handle

Interface MessageSupport

All Known Subinterfaces:

FlowHandle, MessageDispatchTargetHandle, MutableMessageDispatchTargetHandle, SessionHandle

public interface MessageSupport

The MessageSupport interface provides a common API for handling received messages. Applications do not need to instantiate or extend objects with this interface. This interface is already included in all the solclientj interfaces where it is required:

• SessionHandle
• FlowHandle
• MessageDispatchTargetHandle

NOTE: These methods are only applicable in the context of a MessageCallback.onMessage()

Method Summary

Modifier and Type	Method and Description
MessageHandle	getRxMessage() This method returns a MessageHandle reference valid only in the context of the of MessageCallback.onMessage().
void	takeRxMessage(MessageHandle in_out_messageHandle) Use this method to make the received message available outside the scope of MessageCallback.onMessage() Note: client applications must call Handle.destroy() on the MessageHandle reference when they are done with it

Method Detail

getRxMessage

MessageHandle getRxMessage()

This method returns a MessageHandle reference valid only in the context of the of MessageCallback.onMessage(). Client applications that require a MessageHandle reference available outside of the scope of the message callback must call MessageSupport.takeRxMessage() instead.

Note: client applications must not call Handle.destroy() on the returned MessageHandle reference

Returns:

MessageHandle

See Also:

MessageSupport.takeRxMessage(com.solacesystems.solclientj.core.handle.MessageHandle)

takeRxMessage

void takeRxMessage(MessageHandle in_out_messageHandle)
            throws SolclientException

Use this method to make the received message available outside the scope of MessageCallback.onMessage() Note: client applications must call Handle.destroy() on the MessageHandle reference when they are done with it

Parameters:

in_out_messageHandle - an "unbound" message handle which gets bound to the received CCSMP message object after the method returns

Throws:

SolclientException