HoloToolkit.Sharing.ServerSessionsTracker Class Reference

The ServerSessionsTracker manages the list of sessions on the server and the users in these sessions. Instance is created by Sharing Stage when a connection is found. More...

Inheritance diagram for HoloToolkit.Sharing.ServerSessionsTracker:

Public Member Functions
	ServerSessionsTracker (SessionManager sessionMgr)
Session	GetCurrentSession ()
	Retrieves the current session, if any. More...
bool	JoinSession (Session session)
	Join the specified session. More...
void	LeaveCurrentSession ()
	Leave the current session. More...
bool	CreateSession (string sessionName)
	Creates a new session on the server. More...
void	Dispose ()

Protected Member Functions
virtual void	Dispose (bool disposing)

Properties
List< Session >	Sessions [get]
	List of sessions on the server. More...
bool	IsServerConnected [get]
	Indicates whether there is a connection to the server or not. More...

Events
Action< bool, string >	SessionCreated
Action< Session >	SessionAdded
Action< Session >	SessionClosed
Action< Session, User >	UserChanged
Action< Session, User >	UserJoined
Action< Session, User >	UserLeft
Action< Session >	CurrentUserLeft
Action< Session >	CurrentUserJoined
Action	ServerConnected
Action	ServerDisconnected

Detailed Description

The ServerSessionsTracker manages the list of sessions on the server and the users in these sessions. Instance is created by Sharing Stage when a connection is found.

Definition at line 14 of file ServerSessionsTracker.cs.

Constructor & Destructor Documentation

ServerSessionsTracker()

HoloToolkit.Sharing.ServerSessionsTracker.ServerSessionsTracker

(

SessionManager

sessionMgr

)

Definition at line 43 of file ServerSessionsTracker.cs.

Member Function Documentation

CreateSession()

bool HoloToolkit.Sharing.ServerSessionsTracker.CreateSession

(

string

sessionName

)

Creates a new session on the server.

Parameters

sessionName

Name of the session.

Returns

True if a session was created, false if not.

Definition at line 108 of file ServerSessionsTracker.cs.

Dispose() [1/2]

void HoloToolkit.Sharing.ServerSessionsTracker.Dispose

(

)

Definition at line 209 of file ServerSessionsTracker.cs.

Dispose() [2/2]

virtual void HoloToolkit.Sharing.ServerSessionsTracker.Dispose ( bool  disposing )

protectedvirtual

Definition at line 215 of file ServerSessionsTracker.cs.

GetCurrentSession()

Session HoloToolkit.Sharing.ServerSessionsTracker.GetCurrentSession

(

)

Retrieves the current session, if any.

Returns

Current session the app is in. Null if no session is joined.

Definition at line 68 of file ServerSessionsTracker.cs.

JoinSession()

bool HoloToolkit.Sharing.ServerSessionsTracker.JoinSession

(

Session

session

)

Join the specified session.

Parameters

session

Session to join.

Returns

True if the session is being joined or is already joined.

Definition at line 78 of file ServerSessionsTracker.cs.

LeaveCurrentSession()

void HoloToolkit.Sharing.ServerSessionsTracker.LeaveCurrentSession

(

)

Leave the current session.

Definition at line 92 of file ServerSessionsTracker.cs.

Property Documentation

IsServerConnected

bool HoloToolkit.Sharing.ServerSessionsTracker.IsServerConnected

get

Indicates whether there is a connection to the server or not.

Definition at line 41 of file ServerSessionsTracker.cs.

Sessions

List<Session> HoloToolkit.Sharing.ServerSessionsTracker.Sessions

get

List of sessions on the server.

Definition at line 36 of file ServerSessionsTracker.cs.

Event Documentation

CurrentUserJoined

Action<Session> HoloToolkit.Sharing.ServerSessionsTracker.CurrentUserJoined

Definition at line 28 of file ServerSessionsTracker.cs.

CurrentUserLeft

Action<Session> HoloToolkit.Sharing.ServerSessionsTracker.CurrentUserLeft

Definition at line 27 of file ServerSessionsTracker.cs.

ServerConnected

Action HoloToolkit.Sharing.ServerSessionsTracker.ServerConnected

Definition at line 30 of file ServerSessionsTracker.cs.

ServerDisconnected

Action HoloToolkit.Sharing.ServerSessionsTracker.ServerDisconnected

Definition at line 31 of file ServerSessionsTracker.cs.

SessionAdded

Action<Session> HoloToolkit.Sharing.ServerSessionsTracker.SessionAdded

Definition at line 21 of file ServerSessionsTracker.cs.

SessionClosed

Action<Session> HoloToolkit.Sharing.ServerSessionsTracker.SessionClosed

Definition at line 22 of file ServerSessionsTracker.cs.

SessionCreated

Action<bool, string> HoloToolkit.Sharing.ServerSessionsTracker.SessionCreated

Definition at line 20 of file ServerSessionsTracker.cs.

UserChanged

Action<Session, User> HoloToolkit.Sharing.ServerSessionsTracker.UserChanged

Definition at line 24 of file ServerSessionsTracker.cs.

UserJoined

Action<Session, User> HoloToolkit.Sharing.ServerSessionsTracker.UserJoined

Definition at line 25 of file ServerSessionsTracker.cs.

UserLeft

Action<Session, User> HoloToolkit.Sharing.ServerSessionsTracker.UserLeft

Definition at line 26 of file ServerSessionsTracker.cs.

---

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

• Assets/HoloToolkit/Sharing/Scripts/ServerSessionsTracker.cs