WS Comms Protocol

Real-time communication between the Franklyn server, Sentinels, and Proctors happens over WebSocket connections using JSON messages with an Authorization: Bearer <jwt> header for authentication.

Overview

Connection Type	Role	Description
Server - Sentinel	Frame Producer	Student machines stream screen captures to the server
Server - Proctor	Frame Consumer	Teacher interface receives frames for monitored students

Documentation

Connection Lifecycle

Connection flow and sequence diagrams

Server - Sentinel

Registration and frame streaming

Server - Proctor

Registration, subscriptions, and frame receiving

Special Datatypes

Custom data structures used in messages

Last updated on March 16, 2026 • J.H.F.