Connections, Homes, and Sessions

In this Lesson

In this lesson you will be taking a peek behind the scenes (pardon the pun). You will learn how scenes and agents are organized in the runtime environment.


Let’s begin by looking at some word definitions

  • Connection
    A connection is created when a Soiree client connects to SxServer. It is a data structure which contains the following
    • Information about the Soiree client which established the connection
    • The user name associated to the connection (if/when the user authenticates)
    • A list of the active homes associated with the client (described next)
  • Home
    A home is a data structure describing what is to be displayed by a Soiree client. You can think of a home as visual container which presents scenes to the user.
    • Desktop Client
      Soiree solutions designed for the desktop client may use more than one home. The desktop client will present each home as a separate window (a native application window). Up to this point your solution has used only one home – it is the window you see when you start the Soiree client.
    • Mobile Client
      Soiree solutions designed for a mobile environment (iOS and Android) must use only one home and it will be used to display the scenes contained in the app.

    The home data structure simply contains a list of the active sessions (described next) which are owned by the home.

  • Session
    A session is a data structure describing the current state of a single scene at runtime. It contains
    • The scene name
    • The active scene layers
    • The agents associated to the active layers
    • The context values being shared among the agents

These these concepts can be illustrated as follows

One Scene per Session
A session may display only a single scene.

Scene Transitions

A scene transition replaces the current scene in session with the requested scene. In your party solution the PartySplash scene transitions to the PartyDefinition scene when you click on the fish. When this occurs the session replaces its active scene with the requested scene.

That’s all for this lesson.