Table of Contents

Rialto

...

Server Initialisation

Not Running→Inactive

PlantUML Macro

format	SVG
title	Not Running to Inactive

@startuml

autonumber

participant  ApplicationManager
participant RialtoServerManager

ApplicationManager             ->  RialtoServerManager:               changeSessionServerStatecreate(applicationstate_idobserver, AppState::Inactiveconfig)
RialtoServerManagernote right: config allows app manager to specify number of preloaded servers, ->path to RialtoServerManager:RialtoApplicationSessionServer binary, startup timer and heathcheck interval
RialtoServerManager -> RialtoServerManager: Read Rialto-Config json file and  Generate unique session_management_socket_name for App to Rialto Session Server communication
RialtoServerManager            ->  RialtoServerManager:       load config.
RialtoServerManager -> RialtoServerManager: Read Rialto-Config json overrides file and override config.
loop For num of preloaded server 
ref over RialtoServerManager, RialtoApplicationSessionServer : [[#RialtoApplicationSessionManagement-NotRunning→Unitialized(serverpreloading) Not Running→Unitialized (server preloading)]] 
end
 RialtoServerManager        Generate socketpair for  --> ApplicationManager:       
@enduml

Rialto Application State Changes

Not Running→Unitialized (server preloading)

PlantUML Macro

format	SVG

@startuml

autonumber

participant RialtoServerManager
Rialto Session Server to Server Manager communication
RialtoServerManager            ->  RialtoApplicationSessionServer **RialtoServerManager: Spawn(socket)
RialtoServerManager            ->  RialtoServerManager:Generate socketpair for Rialto Application Session Server to Server Manager communication
RialtoServerManager     Start [1] second READY timer
RialtoServerManager   ->  RialtoApplicationSessionServer **: Spawn(server_manager_socket)
note left
Spawn preloaded Application
Session Servers --> ApplicationManager:     to speed up app launch time.
end note
RialtoServerManager           OK/ERROR
RialtoApplicationSessionServer ->  RialtoApplicationSessionServerRialtoServerManager:    Set current_state = Uninitiliased

alt RialtoApplicationSessionServer started successfully

RialtoApplicationSessionServer -//     Start [startup] second READY timer
RialtoApplicationSessionServer ->  RialtoApplicationSessionServer:    Set current_state = Uninitialised

alt RialtoApplicationSessionServer started successfully

RialtoApplicationSessionServer -// RialtoServerManager:               StateChangedstateChanged(AppState::Uninitialised)
RialtoServerManager            ->  RialtoServerManager:               Cancel READY timer
RialtoServerManager          

else Session -// ApplicationManager: Server initialisation failed

RialtoServerManager            ->   StateChanged(application_id, AppState::Uninitialised)
RialtoServerManagerRialtoServerManager:               Cancel READY timer
RialtoApplicationSessionServer ->  RialtoApplicationSessionServer:    Unbind/free SetConfiguration(session_ management_ socket_name, AppState::Inactive, resources, log_level)
note right
"resources" structure will specify the maximum decoder resources that the
application is permitted to use. For now it shall have a max_playback_sessions
property and a supports_web_audio flag. This may be enhanced for things like
HD/UHD, audio only etc in future.
end note
RialtoApplicationSessionServer --> RialtoServerManager:
RialtoApplicationSessionServer ->  RialtoApplicationSessionServer:    Create listening socket & bind to session_management_socket_name

alt State transition successful (if created)
RialtoApplicationSessionServer ->  RialtoApplicationSessionServer !!: Exit process  

else READY timer expired

RialtoServerManager            ->  RialtoServerManager:               Kill spawned Rialto Application Session Server process
RialtoApplicationSessionServer ->  RialtoApplicationSessionServer:    Unbind/free session management socket (if created)

end

@enduml

Not Running (no server preloading)/Unitialized (server preloading)→Inactive

PlantUML Macro

format	SVG
title	Not Running to Inactive

@startuml

autonumber

participant ApplicationManager
participant RialtoServerManager

ApplicationManager Set current_state = Inactive
RialtoApplicationSessionServer -// RialtoServerManager:               StateChanged(AppState::Inactive)
RialtoServerManager            -//>  ApplicationManagerRialtoServerManager:                StateChangedinitiateApplication(application_id, AppState::Inactive, app_config) 
ApplicationManager
alt There are no preloaded servers
RialtoServerManager            ->  RialtoServerManager:               GetAppConnectionInfo()
RialtoServerManagerGenerate socketpair for Rialto Application Session Server to Server Manager communication
RialtoServerManager  --> ApplicationManager:         ->  RialtoApplicationSessionServer     session_management_socket_name
else State transition failed
RialtoApplicationSessionServer**: Spawn(server_manager_socket)
RialtoServerManager            ->  RialtoApplicationSessionServerRialtoServerManager:    Unbind/free  session management socket (if created)       Start [startup] second READY timer
RialtoApplicationSessionServer ->  RialtoApplicationSessionServer:    Set current_state = Uninitialised

alt RialtoApplicationSessionServer started successfully

RialtoApplicationSessionServer -// RialtoServerManager:               StateChangedstateChanged(AppState::ErrorUninitialised)
RialtoServerManager            -//>  ApplicationManagerRialtoServerManager:                StateChanged(application_id, AppState::Error)
RialtoApplicationSessionServer ->  RialtoApplicationSessionServer !!: Exit process
end

Cancel READY timer
RialtoServerManager            -// ApplicationManager:                stateChanged(application_id, AppState::Uninitialised)

ref over ApplicationManager, RialtoApplicationSessionServer : [[#RialtoApplicationSessionManagement-Unitialized→Inactive Unitialized→Inactive]]  

else Session Server initialisation failed

RialtoApplicationSessionServer ->  RialtoApplicationSessionServer:    Unbind/free session management socket (if created)
RialtoApplicationSessionServer -// RialtoServerManager:               StateChangedstateChanged(AppState::Error)
RialtoServerManager            ->  RialtoServerManager:               Cancel READY timer
RialtoApplicationSessionServer ->  RialtoApplicationSessionServer !!: Exit process
RialtoServerManager            -// ApplicationManager:                StateChangedstateChanged(application_id, AppState::Error)

else READY timer expired

RialtoServerManager            ->  RialtoServerManager:               Kill spawned Rialto Application Session Server process
RialtoServerManager            -// ApplicationManager:                StateChangedstateChanged(application_id, AppState::Error)

end

@enduml

3. socketpair is used to create the point-to-point IPC channel used for all Rialto Server Manager to Rialto Application Session Server communications

7/8. Session server creates the share memory region and listening socket that the app will use for sending AV data and control respectively.

else There are preloaded servers
note over ApplicationManager, RialtoApplicationSessionServer: Pick 1st free preloaded server (it's already in unitialized state)
ref over ApplicationManager, RialtoApplicationSessionServer : [[#RialtoApplicationSessionManagement-Unitialized→Inactive Unitialized→Inactive]]
RialtoServerManager            --> ApplicationManager:                OK/ERROR
end

@enduml

Unitialized→Inactive

PlantUML Macro

format	SVG
title	Not Running to Inactive

@startuml

autonumber

participant ApplicationManager
participant RialtoServerManager 

opt session_management_socket_name not specified in app_config
RialtoServerManager            ->  RialtoServerManager:               Generate unique session_management_socket_name for Rialto Client to Rialto Application Session Server communication
end
note right
 "app_config allows app manager to specify the socket name 
  to use for Rialto client/server session management 
  and the socket name for communication with a display server"
end note


RialtoServerManager            ->  RialtoApplicationSessionServer:    SetConfiguration(session_management_socket_name, AppState::Inactive, resources, log_level, display_name)
note right
"resources" structure will specify the maximum decoder resources that the
application is permitted to use. For now it shall have a max_playback_sessions
property and a supports_web_audio flag. This may be enhanced for things like
HD/UHD, audio only etc in future.
end note
RialtoApplicationSessionServer --> RialtoServerManager:
RialtoApplicationSessionServer ->  RialtoApplicationSessionServer:    Create listening socket & bind to session_management_socket_name
opt display_name defined
 RialtoApplicationSessionServer ->  RialtoApplicationSessionServer:    Set WAYLAND_DISPLAY environment variable
end

alt State transition successful
RialtoApplicationSessionServer ->  RialtoApplicationSessionServer:    Set current_state = Inactive
RialtoApplicationSessionServer -// RialtoServerManager:               stateChanged(AppState::Inactive)
RialtoServerManager            -// ApplicationManager:                StateChanged(application_id, AppState::Inactive)
ApplicationManager             ->  RialtoServerManager:               getAppConnectionInfo()
RialtoServerManager            --> ApplicationManager:                session_management_socket_name

else State transition failed

RialtoApplicationSessionServer ->  RialtoApplicationSessionServer:    Unbind/free session management socket (if created)
RialtoApplicationSessionServer -// RialtoServerManager:               stateChanged(AppState::Error)
RialtoServerManager            -// ApplicationManager:                stateChanged(application_id, AppState::Error)
RialtoApplicationSessionServer ->  RialtoApplicationSessionServer !!: Exit process
end

opt Server preloading is active
	note over ApplicationManager, RialtoApplicationSessionServer: Preload RialtoApplicationSessionServer in place of the one that has just been allocated
	ref over ApplicationManager, RialtoApplicationSessionServer : [[#RialtoApplicationSessionManagement-NotRunning→Unitialized(serverpreloading) Not Running→Unitialized (server preloading)]]
end

@enduml

3. socketpair is used to create the point-to-point IPC channel used for all Rialto Server Manager to Rialto Application Session Server communications
810. Application Session Server sends first message so Server Manager knows that it is now up and running
13/14. Session . Session server creates the socket that the app will use for sending AV data and control respectively.
17/18. Server Manager has an API to allow the Application Manager to get the socket name that the App will use for communication with Rialto which it should fetch as soon as it is notified that Rialto has moved the app out of the Not Running state so that it can be passed to the app/container when it is launched.is launched (this is optional as the app manager can supply the socket name in step 1)

Inactive→Active

PlantUML Macro

format	SVG
title	Inactive to Active

@startuml

autonumber

participant ApplicationManager
participant RialtoServerManager
participant RialtoApplicationSessionServer

ApplicationManager             ->  RialtoServerManager:               changeSessionServerState(application_id, AppState::Active)
RialtoServerManager            ->  RialtoApplicationSessionServer:    SetState(AppState::Active)
RialtoApplicationSessionServer --> RialtoServerManager:               OK/ERROR
RialtoServerManager            --> ApplicationManager:                OK/ERROR
RialtoApplicationSessionServer ->  RialtoApplicationSessionServer:    Allocate shared memory buffer

opt State transition successful
RialtoApplicationSessionServer ->  RialtoApplicationSessionServer:    Set current_state = Active
RialtoApplicationSessionServer -// RialtoServerManager:               StateChangedstateChanged(AppState::Active)
RialtoServerManager            -// ApplicationManager:                StateChangedstateChanged(application_id, AppState::Active)
else State transition failed
RialtoApplicationSessionServer ->  RialtoApplicationSessionServer:    Free shared memory buffer if allocated
RialtoApplicationSessionServer -// RialtoServerManager:               StateChangedstateChanged(AppState::Error)
RialtoServerManager            -// ApplicationManager:                StateChangedstateChanged(application_id, AppState::Error)
end

@enduml

...

PlantUML Macro

format	SVG
title	Active to Inactive

@startuml

autonumber

participant ApplicationManager
participant RialtoServerManager
participant RialtoApplicationSessionServer

ApplicationManager             ->  RialtoServerManager:               changeSessionServerState(application_id, AppState::Inactive)
RialtoServerManager            ->  RialtoApplicationSessionServer:    SetState(AppState::Inactive)
RialtoApplicationSessionServer --> RialtoServerManager:               OK/ERROR
RialtoServerManager            --> ApplicationManager:                OK/ERROR
RialtoApplicationSessionServer ->  RialtoApplicationSessionServer:    Free any remaining CDM resources
RialtoApplicationSessionServer ->  RialtoApplicationSessionServer:    Free any remaining Player resources
RialtoApplicationSessionServer ->  RialtoApplicationSessionServer:    Unmap/free shared memory buffer
RialtoApplicationSessionServer ->  RialtoApplicationSessionServer:    Set current_state = Inactive
RialtoApplicationSessionServer -// RialtoServerManager:               StateChangedstateChanged(AppState::Inactive)
RialtoServerManager            -// ApplicationManager:                StateChangedstateChanged(application_id, AppState::Inactive)

@enduml

...

PlantUML Macro

format	SVG
title	Inactive to Not Running

@startuml

autonumber

participant ApplicationManager
participant RialtoServerManager
participant RialtoApplicationSessionServer

ApplicationManager             ->  RialtoServerManager:               changeSessionServerState(application_id, AppState::NotRunning)
RialtoServerManager            ->  RialtoApplicationSessionServer:    SetState(AppState::NotRunning)
RialtoApplicationSessionServer ->  RialtoServerManagerRialtoApplicationSessionServer:    Close IPC connection with app
RialtoApplicationSessionServer ->  RialtoApplicationSessionServer:    changeSessionServerState(application_id, AppState::NotRunning)
RialtoServerManager  Set current_state = NotRunning
RialtoApplicationSessionServer -// RialtoServerManager:          ->  RialtoApplicationSessionServer:    SetStatestateChanged(AppState::NotRunning)
RialtoApplicationSessionServer ->  RialtoApplicationSessionServer !!: Exit process
RialtoServerManager       Close IPC connection with app
RialtoApplicationSessionServer ->//  RialtoApplicationSessionServerApplicationManager:    Set current_state = NotRunning
RialtoApplicationSessionServer -// RialtoServerManager:               StateChanged(AppState::NotRunning)
RialtoApplicationSessionServer ->  RialtoApplicationSessionServer !!: Exit process
RialtoServerManager            -// ApplicationManager:                StateChanged(application_id, AppState::NotRunning)

@enduml

6. The Session Server process should self terminate once it has sent the NotRunning notification to the Server Manager.

Active→Not Running

Not shown for brevity, but should perform all of the cleanup operations in Rialto Sessions server shown in Active→Inactive & Inactive->Not Running.

Application Management

Start Application in Inactive State

stateChanged(application_id, AppState::NotRunning)

@enduml

6. The Session Server process should self terminate once it has sent the NotRunning notification to the Server Manager.

Active→Not Running

Not shown for brevity, but should perform all of the cleanup operations in Rialto Sessions server shown in Active→Inactive & Inactive->Not Running.

Application Management

Start Application in Inactive State

PlantUML Macro

format	SVG
title	Launch application in Inactive state

@startuml
autonumber
participant ApplicationManager
participant RialtoApplicationSessionServer
ref over ApplicationManager, RialtoApplicationSessionServer : [[#RialtoApplicationSessionManagement-NotRunning→Inactive Not Running to Inactive]]
ApplicationManager             ->  Application ** :                Spawn(AppState::Inactive, listening_socket_name)
Application                    ->  RialtoClient ** :               Load RialtoClient library
Application

PlantUML Macro

format	SVG
title	Launch application in Inactive state

@startuml
autonumber
participant ApplicationManager
participant RialtoApplicationSessionServer
ref over ApplicationManager, RialtoApplicationSessionServer : [[#RialtoSessionManagementSequenceDiagrams-NotRunning→Inactive Not Running to Inactive]]
ApplicationManager             ->  RialtoClient Application: ** :                Spawn(AppState::Inactive, listening_socket_nameregisterClient()
ApplicationRialtoClient                    ->  RialtoClient ** :               Load RialtoClient library
RialtoClientRialtoApplicationSessionServer: Connect(rialto_listening_socket)
note right
Connect is not an API call, it is establishing IPC channel with server
end note
opt first registerClient call
    RialtoClient               ->  RialtoApplicationSessionServer: Connect(rialto_listening_socket)
note right
Connect is not an API call, it is establishing IPC channel with server
end note registerClient()
    RialtoApplicationSessionServer --> RialtoClient:               status, AppState::Inactive
end
RialtoClient                   --> Application:                    status, AppState::Inactive
Application                    -// ApplicationManager:             StateChangedstateChanged(AppState::Inactive)
@enduml

...

PlantUML Macro

format	SVG
title	Launch application in Running state

@startuml

autonumber

participant ApplicationManager
participant RialtoApplicationSessionServer

ref over ApplicationManager, RialtoApplicationSessionServer : [[#RialtoSessionManagementSequenceDiagrams#RialtoApplicationSessionManagement-NotRunning→Active Not Running to Active]]

ApplicationManager             ->  Application ** :                Spawn(AppState::Running, listening_socket_name) listening_socket_name)
Application                    ->  RialtoClient ** :               load RialtoClient library
Application                    ->  RialtoClient **: :               load RialtoClient libraryregisterClient()
RialtoClient                   ->  RialtoApplicationSessionServer: Connect(rialto_listening_socket)
note right
Connect is not an API call, it is establishing IPC channel with server
end note
RialtoClientopt first registerClient call
    RialtoClient               --> ApplicationRialtoApplicationSessionServer:
Application  registerClient()
                  RialtoApplicationSessionServer -->  RialtoClient:                   setApplicationState(Running)status, AppState::Running
end
RialtoClient                   ->  RialtoApplicationSessionServer: GetSharedMemory()
RialtoApplicationSessionServer --> RialtoClient:                   shm_fd
RialtoClient                   ->  RialtoClient:                   Map shared memory
RialtoClient                   --> Application:                    status, AppState::Running
Application                    -// ApplicationManager:             StateChangedstateChanged(AppState::Running)

@enduml

Switch Application from Inactive to Running State

PlantUML Macro

format	SVG
title	Application state change: Inactive to Running

@startuml

autonumber

participant ApplicationManager
participant RialtoApplicationSessionServer
participant Application
participant RialtoClient

ref over ApplicationManager, RialtoApplicationSessionServer : [[#RialtoSessionManagementSequenceDiagrams#RialtoApplicationSessionManagement-Inactive→Active Inactive to Active]] 

ApplicationManager             RialtoApplicationSessionServer ->  Application RialtoClient:                   NotifyNewStatestateChanged(AppState::Running)
ApplicationRialtoClient                    ->  RialtoClientApplication:                    setApplicationStatestateChanged(AppState::Running)
RialtoClient                   ->  RialtoApplicationSessionServer: GetSharedMemory()
RialtoApplicationSessionServer --> RialtoClient:                   shm_fd
RialtoClient                   ->  RialtoClient:                   Map shared memory
RialtoClient                   --> Application:                    status
ApplicationManager             ->  Application :                    statusNotifyNewState(AppState::Running)
Application                    -// ApplicationManager:             StateChangedstateChanged(AppState::Running)

@enduml

...

PlantUML Macro

format	SVG
title	Application state change: Running to Inactive

@startuml

autonumber

participant ApplicationManager
participant RialtoApplicationSessionServer
participant Application
participant RialtoClient

ApplicationManager             ->  Application :       NotifyNewState(AppState::Inactive)
Application                    -->  ApplicationManager:
RialtoApplicationSessionServer -> RialtoClient:       NotifyNewState stateChanged(AppState::Inactive)
ApplicationRialtoClient         ->  RialtoClient:       setApplicationState(Inactive)
RialtoClient        ->  RialtoClient :      Free CDM & Player resources
RialtoClient                   ->  RialtoClient:       Unmap shared memory
RialtoClient        --> Application:        status
Application  --> Application:      -// ApplicationManager: StateChangedstateChanged(AppState::Inactive)

ref over ApplicationManager, RialtoApplicationSessionServer : [[#RialtoSessionManagementSequenceDiagrams#RialtoApplicationSessionManagement-Active→Inactive Active to Inactive]] 

@enduml

Stop Application from Inactive State

PlantUML Macro

format	SVG
title	Application state change: Inactive to Not Running

@startuml

autonumber

participant ApplicationManager
participant RialtoApplicationSessionServer
participant Application
participant RialtoClient

ApplicationManager  ->  Application :       NotifyNewState(AppState::NotRunning)
Application         -// ApplicationManager: StateChangedstateChanged(AppState::NotRunning)
Application         ->  RialtoClient:       Unload library
RialtoClient        ->  RialtoClient !!:
Application         ->  Application !!:

ref over ApplicationManager, RialtoApplicationSessionServer : [[#RialtoSessionManagementSequenceDiagrams#RialtoApplicationSessionManagement-Inactive→NotRunning Inactive to Not Running]]

@enduml

...

PlantUML Macro

format	SVG
title	Application state change: Running to Not Running

@startuml

autonumber

participant ApplicationManager
participant RialtoApplicationSessionServer
participant Application
participant RialtoClient

ApplicationManager  ->  Application :       NotifyNewState(AppState::NotRunning)

Application         ->  RialtoClient:       setApplicationState(Inactive)
RialtoClient        ->  RialtoClient :      Free CDM & Player resources
RialtoClient        ->  RialtoClient:       Unmap shared memory
RialtoClient        --> Application:        status
Application         -// ApplicationManager: StateChangedstateChanged(AppState::NotRunning)
Application         ->  RialtoClient:       Unload library
RialtoClient        ->  RialtoClient !!:
Application         ->  Application !!:

ref over ApplicationManager, RialtoApplicationSessionServer : [[#RialtoSessionManagementSequenceDiagrams#RialtoApplicationSessionManagement-Active→NotRunning Active to Not Running]]

@enduml

...

PlantUML Macro

format	SVG
title	Active / Inactive Application Switch

@startuml

autonumber

participant ApplicationManager
participant RialtoServerManager

note across : First make App_1 Inactive
ref over ApplicationManager, RialtoServerManager : [[#RialtoSessionManagementSequenceDiagrams#RialtoApplicationSessionManagement-Active→Inactive Active->Inactive(app_id_1)]]

note across
Once Application Manager has received
the state change event to Inactive for
app_id_1 it can then make App_2 Active
end note
ref over ApplicationManager, RialtoServerManager : [[#RialtoSessionManagementSequenceDiagrams#RialtoApplicationSessionManagement-Inactive→Active Inactive->Active(app_id_2)]]

@enduml

RDK Resources

[RDK Preferred]

Code Management Facility

RDK Forums

[RDK Conferences]

RDK Support

Archives

Versions Compared

Old Version 4

New Version Current

Key

Rialto

Server Initialisation

Not Running→Inactive

Rialto Application State Changes

Not Running→Unitialized (server preloading)

Not Running (no server preloading)/Unitialized (server preloading)→Inactive

Unitialized→Inactive

Inactive→Active

Active→Not Running

Application Management

Start Application in Inactive State

Active→Not Running

Application Management

Start Application in Inactive State

Switch Application from Inactive to Running State

Stop Application from Inactive State

RDK Resources

[*RDK Preferred*]

Code Management Facility

RDK Forums

[RDK Conferences]

RDK Support

Archives

Page History

Versions Compared

Old Version 4

New Version Current

Key

Rialto

Server Initialisation

Not Running→Inactive

Rialto Application State Changes

Not Running→Unitialized (server preloading)

Not Running (no server preloading)/Unitialized (server preloading)→Inactive

Unitialized→Inactive

Inactive→Active

Active→Not Running

Application Management

Start Application in Inactive State

Active→Not Running

Application Management

Start Application in Inactive State

Switch Application from Inactive to Running State

Stop Application from Inactive State

[RDK Preferred]