com.solacesystems.solclientj.core.handle

Interface ContextHandle

All Superinterfaces:

Handle

public interface ContextHandle
extends Handle

The ContextHandle interface represents a processing context in which session instances are created. It is used to organize communications between an application and a Solace Appliance. Contexts act as containers for configuring one or more sessions and handling session-related events.

Applications that need this interface must instantiate an object with the ContextHandle interface by calling Allocator.newContextHandle()

Method Summary

Modifier and Type	Method and Description
int	createSessionForHandle(SessionHandle in_out_sessionHandle, java.lang.String[] properties, MessageCallback messageCallback, SessionEventCallback sessionEventCallback) Allocates a new session instance which will be bound to an unbound SessionHandle within a specified Context.

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

destroy, isBound

Method Detail

createSessionForHandle

int createSessionForHandle(SessionHandle in_out_sessionHandle,
                           java.lang.String[] properties,
                           MessageCallback messageCallback,
                           SessionEventCallback sessionEventCallback)
                    throws SolclientException

Allocates a new session instance which will be bound to an unbound SessionHandle within a specified Context. The "session properties" are supplied as an array of name/value pointer pairs, where the name and value are both strings. Only configuration property names that are members of SessionHandle.PROPERTIES are processed; other property names are ignored. Any values not supplied are set to default values. When the Session is created, the SessionHandle is considered bound (see SessionHandle.isBound() ) , and the SessionHandle is then used for any Session-level operations (for example, sending a message). The passed-in object MessageCallback provides information on the message receive callback method. The passed-in object SessionEventCallback provides information on the Session event method which the application has provided for this Session.

Both of these objects are mandatory. The message receive callback is invoked for each received message on this Session. The Session event callback is invoked when Session events occur, such as the Session going up or down. Both callbacks are invoked in the context of the Context thread to which this Session belongs.

Parameters:

in_out_sessionHandle - an unbound SessionHandle which will be bound to the newly created Session

properties - an array of property names and values ([propName1,propValue1,propNam2,propValue2,...]) where property names is defined in SessionHandle.PROPERTIES

messageCallback -

sessionEventCallback -

Returns:

as defined in SolEnum.ReturnCode

Throws:

SolclientException