com.solacesystems.solclientj.core.handle

Interface Handle

All Known Subinterfaces:

CacheSessionHandle, ContextHandle, FlowHandle, MessageDispatchTargetHandle, MessageHandle, MutableMessageDispatchTargetHandle, NativeDestinationHandle, ReplicationGroupMessageIdHandle, SessionHandle, TransactedSessionHandle

public interface Handle

Abstraction of a native object.

A Handle represents a binding of an API layer concept to its underlying native object. A Handle instance is created by calling one of the of Solclient.Allocator new methods

A Handle instance has the following characteristics:

• A Handle instance is not bound to a native object when it's initially created. Calling Handle.isBound() will return false
• A Handle instance becomes bound after it's passed in to one of the create methods (for example Solclient.createContextForHandle())
• Calling Handle.destroy() will destroy the native object and render the Handle reference unbound. At this point, the Handle instance can be re-used.

Method Summary

Modifier and Type	Method and Description
void	destroy() This method will destroy the native object associated with this Handle instance.
boolean	isBound() Returns true if this Handle object is bound to native object.

Method Detail

isBound

boolean isBound()

Returns true if this Handle object is bound to native object. NOTE: Even when bound, the native object may or may not be valid.

Returns:

true when bound, false otherwise

destroy

void destroy()
      throws SolclientException

This method will destroy the native object associated with this Handle instance.

Throws:

SolclientException - if the destroy fails