WebSessionContext

From Xojo Documentation
Jump to: navigation, search


Class (inherits from Object)

The WebSessionContext class allows you to specify which session the Session object should point to for code that does not have access to a session, such server-driven classes (such as sockets or threads) or the WebApplication class.


Properties
Session ReadOnlyProperty.png


Methods
Stop


Constructors

Name Parameters Description
WebSessionContext Source As WebSession Source refers to the session that should become the active session.


Notes

The constructor parameter is required.

Inside user-driven events or threads created inside user-driven events, such as a Button push, the Session object is automatically available. However, in server-driven events, such as a Socket DataAvailable event, there is no way for the framework to know which session to communicate with. Should you need to communicate with a session from one of these events, this class can be used to inform the framework to which session the Session object should point.

The session context automatically stops when the object goes out of scope.


Example

When placed in the WebApplication.UnhandledException event, this example will change the current page to another page from the application (called ExceptionPage in this case) to inform each user that the application is about to crash due to an unhandled exception.


// Loop through all sessions and have them display a new
// ExceptionPage.
For i As Integer = 0 To App.SessionCount - 1
// Without creating a WebSessionContext here, creating
// the page would fail triggering a SessionNotAvailableException.
Dim context As New WebSessionContext(App.SessionAtIndex(i))

// Because we have a context, we can create a new
// ExceptionPage and assign it to the session.
context.Session.CurrentPage = New ExceptionPage
Next

See Also

Session, WebSession, SessionNotAvailableException

Personal tools
Namespaces

Variants
Actions
Main
Content
Starting Out
Dig Deeper
More Help
Toolbox
About