Platform Symphony .NET API Reference - Version 5.1
Close Method (closeFlags)
NamespacesPlatform.Symphony.SoamSessionClose(SessionCloseFlags)
Closes this Session (mandatory).
Declaration Syntax
C#
public void Close(
	SessionCloseFlags closeFlags
)
Parameters
closeFlags (SessionCloseFlags)

This flag allows the client to specify explicitly what action to take during the closing of the session. The supported flags are as follows:

  • SessionCloseFlags.DestroyOnClose ?This informs the API that the client no longer intends to use the session. This is the default behaviour if the Session.Close() overload is used. Closing the session in this way will result in the session being terminated within the middleware. All outstanding results will be discarded.
  • SessionCloseFlags.DetachOnClose ? This informs the API that the client no longer intends to use the session locally, but intends for the workload to continue running within the middleware. A client must call Connection.OpenSession to gain access to this session once it has been closed with this flag.
Remarks

IMPORTANT NOTE: This call is mandatory. If you do not close the session, you will introduce a resource leak.

Never call Close(...) during the execution of a callback method. This will result in a deadlock.

See Also
[Platform.Symphony.Soam.SessionCloseFlags]
[Platform.Symphony.Soam.Connection.OpenSession]

Assembly: Platform.Symphony.Soam.Net (Module: Platform.Symphony.Soam.Net) Version: 5.1.0.0