Protobuf Message Definitions
The GFN infrastructure uses 121 Protocol Buffer definitions for inter-service communication. These were found as compiled Python _pb2.py files in the Asgard framework.
Message Categories
Session Management
| Proto File | Description |
|---|---|
GameSessionDef | Core game session data model |
GameSessionGameLaunchDataDef | Game launch parameters |
ClientSessionDef | Client-side session with game seat info |
ClientSessionStartDef | Session start event data |
ClientSessionEndDef | Session end with streaming statistics |
SessionIdentifierDef | Session ID types |
SessionResultCodeDef | Session termination result codes |
SessionErrorDef | Session error definitions |
SessionShutdownSettingsDef | Shutdown configuration |
SessionPriorityLevelDef | Session priority levels |
SessionStreamingTimeDataDef | Streaming time tracking |
SessionHeartbeatDef | Session keepalive |
SessionFrontchannelModel | Frontend session communication |
SessionBackchannelModel | Backend session communication |
QueuedSessionDef | Queue waiting session info |
RuntimeSessionDataDef | Runtime session state |
ZoneGameSessionDef | Zone-level session view |
NTSessionDef | Network Transit session |
Game Seat Management
| Proto File | Description |
|---|---|
GameSeatDef | Game seat state and configuration |
GameSeatProcessEventDef | Process creation/termination events on seat |
GameSeatGatewayApiErrorDef | GSG API error messages |
SeatStateDef | Seat state enumeration |
SeatHeartbeatDef | Seat keepalive messages |
SeatFrontchannelModel | Seat frontend communication |
SeatSchedulerCommonDataModel | Scheduler integration |
SeatToPMMessageDef | Seat-to-Provision Manager messages |
QuerySeatStatusDef | Status query messages |
SpotInstanceHeartbeatModel | Spot instance keepalive |
Provision Manager
| Proto File | Description |
|---|---|
PMStatusCodeDef | PM status codes |
PMToSeatMessageDef | PM-to-seat commands |
PmAuditLogStateDef | PM audit logging |
PmGameSessionBasicDef | Basic session info for PM |
PmGameSessionDef | Full PM session view |
PmGameSessionEndStatsDef | End-of-session statistics |
PmGameSessionForAllocationDef | Session data for resource allocation |
PmGameSessionForClientDef | Client-facing session data |
PmGameSessionForNgsStateChangeDef | NGS state change events |
PmGameSessionForReleaseDef | Session release data |
Content & Applications
| Proto File | Description |
|---|---|
AppDataDef | Application executable, args, working dir |
AppTypeDef | Enum: PLATFORM_PREREQUISITE, PLATFORM, PREREQUISITE, APPLICATION, DLC |
AppVersionDef | Version with content and prerequisites |
AppContentStateEnum | States: Available, Patching, NotAvailable, GameNotLinked, etc. |
AppLaunchMode | Enum: DEFAULT, GAMEPAD_FRIENDLY, TOUCH_FRIENDLY |
ApplicationPatchInfoDef | Patch state tracking |
ContentControllerMessagesDef | Content controller messages |
ContentControllerStatusDef | Controller status |
GameLaunchInfoDef | Game launch information |
GameRequirementsDef | System requirements |
GameTitleDef | Game title list and metadata |
PrewarmGameDataDef | Prewarm (pre-load) game data |
PrewarmGamePrerequisiteDef | Prewarm prerequisites |
TitleOperationalDataDef | Title operational metadata |
Authentication & Entitlements
| Proto File | Description |
|---|---|
AuthInfoDef | Auth protocols and error codes |
AuthorizationInfoDef | User authorization (time, storage, entitlements) |
ClientEntitlementsDef | Audio format entitlements |
EntitlementDataDef | Entitlement data |
EntitlementInfoDef | Entitlement info |
Streaming & Client
| Proto File | Description |
|---|---|
ClientInfoDef | Device and browser information |
ClientPacketDef | Client packet structure |
GfnClientInfo | GFN-specific client data |
MonitorSettingsDef | Display resolution, FPS settings |
GameStatisticsDef | Latency, FPS, quality stats |
FeedbackDef | User star ratings |
SdrHdrModeDef | SDR/HDR mode enumeration |
DisplayModeDef | Display mode options |
ResolutionInstanceTypesDef | Resolution-to-instance mapping |
GCIS Communication
| Proto File | Description |
|---|---|
GCISCommunicationMessagesDef | Core GCIS messaging |
GCISInitializeDef | Plugin initialization |
GCISServiceApiDef | GCIS service API |
GFNGuardMessagesDef | GFN Guard security messages |
GfnRuntimeMsgDef | Runtime SDK messages |
Infrastructure
| Proto File | Description |
|---|---|
BifrostPacketDef | Bifrost message bus packets |
ErrorDef | Error (code, name, message, detail) |
EventDef | Event (measurand, duration, data) |
ResponseStatusDef | Response status enumeration |
StringMapDef | Key-value string maps |
TypesDef | Common types (dates, screen resolution) |
PacketIdentifierDef | Packet identifiers |
RegKeyDef | Registry key definitions |
ResourceDef | Resource definitions |
RouteDef | Network route definitions |
StarfleetIdsDef | NVIDIA internal IDs |
Cloud & Platform Services
| Proto File | Description |
|---|---|
NvCloudSaveMessageDef | Cloud save messages |
NvSCIBaseDef / NvSCIDef / NvSCIClientDef / NvSCIServerDef | NVIDIA SCI |
NvSCITimerEventDef | SCI timer events |
NvExtendedCommand | Extended command protocol |
SSIServiceApiDef | SSI service API |
NdcServiceApiDef | NDC (Network Data Capture) API |
UIPluginApiDef | UI plugin API |
VCAAgentMessageDef | VCA agent messages |
VdkAppApiDef | VDK app API |
VMManagerMessageDefinitionDef | VM manager messages |
Network & Transport
| Proto File | Description |
|---|---|
NetworkTransitDataDef | Network transit data |
NTAPIAllocateMessagesDef | NT API resource allocation |
NTAPIDeallocateMessagesDef | NT API resource deallocation |
NTAPIMessageDef | NT API base messages |
NTAPIRequestStatusDef | Request status |
UdpTestPacketDef | UDP test/probe packets |
LightStepConnectionInfoDef | Distributed tracing connection info |
Steam Integration
| Proto File | Description |
|---|---|
SteamSessionDef | Steam session with launch parameters |
SteamTokenFilesSessionDef | Steam auth token files |
Other
| Proto File | Description |
|---|---|
ApiVersionDef | API versioning |
DevSeatDef | Developer seat configuration |
FencedDataDef | Fenced status (data gating) |
GaeaMessageDef | Gaea message system |
GameAgentClientMessageDef | Game agent client protocol |
GSConfiguratorServiceApiDef | GS configurator API |
HealthRecordDef | Health check records |
InstanceTypePriorityGroupDef | Instance type priorities |
LofnKeyInfoDef | LOFN encryption key info |
MessageOfTheDayDef | MOTD system |
PatchInfoDef | Patch info |
PlatformIDDef | Platform ID enum |
PrerequisiteDef | Prerequisites |
ProductModeDef | Product mode enum |
SecureCloudBackchannelModel | Secure backchannel |
UserDataDef | User data |
Key Enumerations
AppContentState
Unknown, Available, Patching, GameNotFoundInZone,
GameCredentialsMissing, NotAvailable, GameNotLinked, ServerMaintenanceAppType
UNKNOWN, PLATFORM_PREREQUISITE, PLATFORM, PREREQUISITE, APPLICATION, DLCAppLaunchMode
UNKNOWN, DEFAULT, GAMEPAD_FRIENDLY, TOUCH_FRIENDLYSeatState
Defined in SeatStateDef — tracks the full lifecycle from idle through session to cleanup.