IContext.CreateSession Method

Solclient

previous page next page

Solclient

IContextCreateSession Method

version: 7.2.1.27

Creates a session instance. Session properties to customize the session, and message receive and the session event delegates must be provided for the session. The message receive delegate is invoked for each received message on this session. The session event delegate is invoked when session events occur, such as the session going up or down. Both delegates are invoked in the context of the context thread to which this session belongs.

Note: disposing the corresponding context (IContext) or any of its contained context timers (TimerTask), sessions (ISession) or flows (IFlow) must not be performed from within the registered delegates (messageEventHandler or sessionEventHandler).

Namespace: SolaceSystems.Solclient.Messaging
Assembly: SolaceSystems.Solclient.Messaging (in SolaceSystems.Solclient.Messaging.dll) Version: 7.2.1.27 (7.2.1.27)

Syntax

C++

Copy

ISession CreateSession(
	SessionProperties props,
	EventHandler<MessageEventArgs> messageEventHandler,
	EventHandler<SessionEventArgs> sessionEventHandler
)

Function CreateSession ( 
	props As SessionProperties,
	messageEventHandler As EventHandler(Of MessageEventArgs),
	sessionEventHandler As EventHandler(Of SessionEventArgs)
) As ISession

ISession^ CreateSession(
	SessionProperties^ props, 
	EventHandler<MessageEventArgs^>^ messageEventHandler, 
	EventHandler<SessionEventArgs^>^ sessionEventHandler
)

Parameters

props: Type: SolaceSystems.Solclient.MessagingSessionProperties
Defined in SessionProperties.
messageEventHandler: Type: SystemEventHandlerMessageEventArgs
A delegate for delivered messages.
sessionEventHandler: Type: SystemEventHandlerSessionEventArgs
A delegate for session events.
Client applications can call GetLastSDKErrorInfo from within the session event delegate to get more info on the type of error condition reported by SessionEventArgs.

Return Value

Type: ISession
A new ISession instance.

Exceptions

Exception	Condition
OperationErrorException	Thrown when unable to create the session. Possible sub-codes: OutOfResources: When resources are exhausted
ObjectDisposedException	Thrown if the context is already disposed (terminal state).
FatalErrorException	Thrown when an unrecoverable error occurs.

Reference

IContext Interface

SolaceSystems.Solclient.Messaging Namespace

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to use and copy the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

UNLESS STATED ELSEWHERE BETWEEN YOU AND SOLACE SYSTEMS, INC., THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Send comments on this topic to [email protected]

previous page start next page