PushTechnology.ClientInterface.Client.Features.Control.Clients.ISessionDetailsListener Interface Reference

The listener for session details notifications. More...

Inheritance diagram for PushTechnology.ClientInterface.Client.Features.Control.Clients.ISessionDetailsListener:

Public Member Functions
void	OnSessionOpen (SessionId sessionId, ISessionDetails sessionDetails)
	Notification that a new client session has been opened. More...
void	OnSessionUpdate (SessionId sessionId, ISessionDetails sessionDetails)
	Notification of a change to a client session. More...
void	OnSessionClose (SessionId sessionId, ISessionDetails sessionDetails, CloseReason closeReason)
	Notification that a client session has closed. More...
Public Member Functions inherited from PushTechnology.ClientInterface.Client.Features.IServerHandler
void	OnActive (IRegisteredHandler registeredHandler)
	Called when the handler has been registered at the server and is now active. More...
void	OnClose ()
	Called if the handler is closed. This happens if the call to register the handler fails, or the handler is unregistered. More...

Detailed Description

The listener for session details notifications.

Member Function Documentation

void PushTechnology.ClientInterface.Client.Features.Control.Clients.ISessionDetailsListener.OnSessionClose	(	SessionId	sessionId,
		ISessionDetails	sessionDetails,
		CloseReason	closeReason
	)

Notification that a client session has closed.

This will be called for every client that closes whilst the listener is registered regardless of the level of detail requested.

Parameters

sessionId	the session identifier of the client that has closed.
sessionDetails	the details of the client session
closeReason	why the session was closed.

void PushTechnology.ClientInterface.Client.Features.Control.Clients.ISessionDetailsListener.OnSessionOpen	(	SessionId	sessionId,
		ISessionDetails	sessionDetails
	)

Notification that a new client session has been opened.

When the listener is registered, this will be called for all existing sessions. It will then be called for every new session that opens whilst the listener is registered.

This will be called for every client session regardless of the level of detail requested.

Parameters

sessionId	the session identifier.
sessionDetails	the details of the client session.

void PushTechnology.ClientInterface.Client.Features.Control.Clients.ISessionDetailsListener.OnSessionUpdate	(	SessionId	sessionId,
		ISessionDetails	sessionDetails
	)

Notification of a change to a client session.

Only called if the change is of interest to the listener, i.e. if detail covered by the requiredDetail parameter changes.

All available details will be supplied, filtered by requiredDetail, not just the changed detail.

Parameters

sessionId
sessionDetails

---

The documentation for this interface was generated from the following file:

• UCIStack/Client/Features/Control/Clients/ISessionDetailsListener.cs