...
| PlantUML Macro |
|---|
|
@startuml
autonumber
participant ApplicationManager
participant RialtoServerManager
ApplicationManager -> RialtoServerManager: create(state_observer, config)
loop For each requested preloaded server
ref over ApplicationManager, RialtoApplicationSessionServer : [[#RialtoApplicationSessionManagement-NotRunning→Inactive Not Running to Inactive]]
end
@enduml |
Rialto Application State Changes
Not Running→Inactive
note right: config allows app manager to specify number of preloaded servers, path to RialtoApplicationSessionServer binary, startup timer and heathcheck interval
RialtoServerManager -> RialtoServerManager: Read Rialto-Config json file and 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 --> ApplicationManager:
@enduml |
Rialto Application State Changes
Not Running→Unitialized (server preloading)
| PlantUML Macro |
|---|
|
@startuml
autonumber
participant RialtoServerManager
|
| PlantUML Macro |
|---|
| format | SVG |
|---|
| title | Not Running to Inactive |
|---|
|
@startuml
autonumber
participant ApplicationManager
participant RialtoServerManager
ApplicationManager -> RialtoServerManager: initiateApplication(application_id, AppState::Inactive, app_config)
note right: app_config allows app manager to specify the socket name to use for Rialto client/server session management
opt Socket name not specified in app_config
RialtoServerManager -> RialtoServerManager: Generate unique session_management_socket_name socketpair for Rialto ClientApplication toSession RialtoServer Applicationto SessionServer ServerManager communication
end
RialtoServerManager -> RialtoServerManagerRialtoApplicationSessionServer **: Spawn(server_manager_socket)
note left
Spawn preloaded Application
Session Servers to speed up app launch time.
end note
RialtoServerManager Generate socketpair for Rialto Application Session Server to Server-> Manager communication
RialtoServerManager: -> RialtoApplicationSessionServer **: Spawn(server_manager_socket, session_management_socket_name)
note left
Depending on configuration, Rialto Server Manager
may maintain a pool of pre-loaded Application
Session Servers in which case one of these will
be used to speed up app launch time.
end noteStart [startup] second READY timer
RialtoApplicationSessionServer -> RialtoApplicationSessionServer: Set current_state = Uninitialised
alt RialtoApplicationSessionServer started successfully
RialtoApplicationSessionServer -// RialtoServerManager: stateChanged(AppState::Uninitialised)
RialtoServerManager -> RialtoServerManager: Start [1] second Cancel READY timer
RialtoServerManager
else Session --> ApplicationManager: Server initialisation failed
RialtoServerManager OK/ERROR
RialtoApplicationSessionServer -> RialtoApplicationSessionServerRialtoServerManager: Set current_state = Uninitialised
alt RialtoApplicationSessionServer started successfully
RialtoApplicationSessionServer -// RialtoServerManager: Cancel READY timer
RialtoApplicationSessionServer -> RialtoApplicationSessionServer: Unbind/free session management socket stateChanged(AppState::Uninitialised(if created)
RialtoServerManagerRialtoApplicationSessionServer -> -> RialtoServerManagerRialtoApplicationSessionServer !!: Exit process Cancel
else READY timer expired
RialtoServerManager -//> ApplicationManagerRialtoServerManager: stateChanged(application_id, AppState::Uninitialised)
RialtoServerManager Kill spawned Rialto Application Session Server process
RialtoApplicationSessionServer -> RialtoApplicationSessionServer: 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 toUnbind/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 -> RialtoServerManager: initiateApplication(application_id, AppState::Inactive, app_config)
alt There are no preloaded servers
RialtoServerManager -> RialtoServerManager: Generate socketpair for Rialto Application Session Server to Server Manager communication
RialtoServerManager -> RialtoApplicationSessionServer **: Spawn(server_manager_socket)
RialtoServerManager -> RialtoServerManager: Start [startup] second READY timer
RialtoApplicationSessionServer -> RialtoApplicationSessionServer: Set current_state = Uninitialised
alt RialtoApplicationSessionServer started successfully
RialtoApplicationSessionServer -// RialtoServerManager: stateChanged(AppState::Uninitialised)
RialtoServerManager -> RialtoServerManager: 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: stateChanged(AppState::Error)
RialtoServerManager -> RialtoServerManager: Cancel READY timer
RialtoApplicationSessionServer -> RialtoApplicationSessionServer !!: Exit process
RialtoServerManager -// ApplicationManager: stateChanged(application_id, AppState::Error)
else READY timer expired
RialtoServerManager -> RialtoServerManager: Kill spawned Rialto Application Session Server process
RialtoServerManager -// ApplicationManager: stateChanged(application_id, AppState::Error)
end
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
alt Statefor transitionRialto successful
RialtoApplicationSessionServer -> RialtoApplicationSessionServer: Set current_state = Inactive
RialtoApplicationSessionServer -// RialtoServerManager: stateChanged(AppState::Inactive)
RialtoServerManager -// ApplicationManager: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: StateChanged(application_id, AppState::Inactive)
ApplicationManager -> RialtoServerManager: getAppConnectionInfo()
RialtoServerManager --> ApplicationManager: 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
elseopt display_name defined
RialtoApplicationSessionServer -> RialtoApplicationSessionServer: Set WAYLAND_DISPLAY environment variable
end
alt State transition failedsuccessful
RialtoApplicationSessionServer -> RialtoApplicationSessionServer: Unbind/free session management socket (if created) Set current_state = Inactive
RialtoApplicationSessionServer -// RialtoServerManager: stateChanged(AppState::ErrorInactive)
RialtoServerManager -// ApplicationManager: stateChangedStateChanged(application_id, AppState::ErrorInactive)
RialtoApplicationSessionServerApplicationManager -> RialtoApplicationSessionServer !!: Exit process
end
else Session Server initialisation failed
RialtoApplicationSessionServer -> RialtoApplicationSessionServer: Unbind/free session management socket (if created)
RialtoApplicationSessionServer -// RialtoServerManager: stateChanged(AppState::ErrorgetAppConnectionInfo()
RialtoServerManager --> ApplicationManager: RialtoServerManager: Cancel READY timersession_management_socket_name
else State transition failed
RialtoApplicationSessionServer -> RialtoApplicationSessionServer !!: Exit process
RialtoServerManager Unbind/free session management socket (if created)
RialtoApplicationSessionServer -// ApplicationManagerRialtoServerManager: stateChanged(application_id, AppState::Error)
else READY timer expired
RialtoServerManager ->// ApplicationManager: RialtoServerManager: Kill spawned Rialto Application Session Server process
RialtoServerManager -// ApplicationManager: stateChanged(application_id, AppState::Error)
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
8. Application Session Server sends first message so Server Manager knows that it is now up and running
13. 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 (this is optional as the app manager can supply the socket name in step 1)
...
| PlantUML Macro |
|---|
| format | SVG |
|---|
| title | Launch application in Inactive state |
|---|
|
@startuml
autonumber
participant ApplicationManager
participant RialtoApplicationSessionServer
ref over ApplicationManager, RialtoApplicationSessionServer : [[#RialtoSessionManagementSequenceDiagrams#RialtoApplicationSessionManagement-NotRunning→Inactive Not Running to Inactive]]
ApplicationManager -> Application ** : Spawn(AppState::Inactive, listening_socket_name)
Application -> RialtoClient ** : Load RialtoClient library
Application -> RialtoClient : registerClient()
RialtoClient -> RialtoApplicationSessionServer: Connect(rialto_listening_socket)
note right
Connect is not an API call, it is establishing IPC channel with server
end note with server
end note
opt first registerClient call
RialtoClient -> RialtoApplicationSessionServer: registerClient()
RialtoApplicationSessionServer --> RialtoClient: status, AppState::Inactive
end
RialtoClient --> Application: status, AppState::Inactive
Application -// ApplicationManager: stateChanged(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)Running, 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
RialtoClient
opt 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: stateChanged(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)
Application RialtoClient -> RialtoClientApplication: setApplicationState stateChanged(AppState::Running)
RialtoClient -> RialtoApplicationSessionServer: GetSharedMemory()
RialtoApplicationSessionServer --> RialtoClient: shm_fd
RialtoClient -> RialtoClient: Map shared memory
RialtoClient --> Application: status
ApplicationManager -> Application : statusNotifyNewState(AppState::Running)
Application -// ApplicationManager: stateChanged(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 :
ApplicationManager -> Application : NotifyNewState(AppState::Inactive)
Application --> ApplicationManager:
RialtoApplicationSessionServer -> RialtoClient: NotifyNewStatestateChanged(AppState::Inactive)
Application RialtoClient -> RialtoClient: setApplicationState(Inactive)
RialtoClient -> RialtoClient : Free CDM & Player resources
RialtoClient -> RialtoClient: Unmap shared memory
RialtoClient --> Application: status
Application --> Application: -// ApplicationManager: stateChanged(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: stateChanged(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: stateChanged(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 |
