Creating Client Sessions
A session creates a single, client connection to a Solace event broker for sending and receiving messages. The (SMF) is used to facilitate the communication between a client and an event broker, and this SMF communication is then encapsulated through a single TCP connection.
By default, sessions are unsecured—in a connected session, the SMF data sent between a client and an event broker is transmitted as plain text. However, it is also possible to establish a secure session that uses Transport Layer Security (TLS)/ Secure Sockets Layer (SSL) protocols so that the SMF data is encrypted. For information on how to configure specific TLS/SSL session properties and establish a secure session, see Creating Secure Sessions.
Sessions are always created within a context. The client application controls whether one or multiple sessions are grouped under a processing context. Once a session is created within a given context, it remains associated with that single context until it is disposed.
To create a session, the client application must provide the following:
- Session properties
Properties used to customize the session. Any session property that is not explicitly supplied is set to default values. Although the defaults can be used in many cases, some client and event broker parameters require specific input from the client to establish a connection to a Message VPN on an event broker. See Session Properties Required to Establish a Connection.
Once a session is created, it must be connected.
To Create a Session
-
solace.SolclientFactory.createSession(...)Creates a session.
-
Session.on(...)Registers a session event listener, e.g., for a
MESSAGEevent.
To Connect a Session
Call Session.connect().
To Close a Session
-
Session.disconnect() -
Session.dispose()
- Calling
disposeto destroy a session object is not required. If the session object is not destroyed, you may reconnect to it at a later time. - Calling
disposereleases all resources associated with the session. Solace recommends callingdisconnectfirst for a proper handshake with the event broker.