Last updated on July 3, 2025
Lobby Server 0.1.0 documentation
- Protobuf File Spec: lobby.proto
Published Messages (lobby)
The service publishes one of these messages below.
userConnected
Contains fields from event and the following payload.
Example value
{
"payload": {
"userConnected": {
"lobbySessionId": "string",
"lobbyLoginType": "string",
"reconnectFrom": 0,
"connectionId": "string",
"platform": "string"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}
payload
| Name | Type | Description |
|---|---|---|
| userConnected | object | - |
payload.userConnected
| Name | Type | Description |
|---|---|---|
| lobbySessionId | string | - |
| lobbyLoginType | string | * NewRegister Fresh connect, no active connection. |
- MultipleSessionLogin An active connection exists, a new connection with different token, old connection will be closed.
- FastReconnect An active connection exists, a new connection with same token and same lobbySessionId, old connection will be closed.
- WrongSessionID An active connection exists, a new connection with same token and different lobbySessionId, new connection is rejected, event is not published. | | reconnectFrom | integer | * 5000 Fresh connect, this wasn't a reconnect.
- 5001 The user is still connected. | | connectionId | string | - | | platform | string | - |
userDisconnected
Contains fields from event and the following payload.
Example value
{
"payload": {
"userDisconnected": {
"reason": "string",
"code": 0,
"platform": "string",
"lobbySessionId": "string",
"isReconnecting": true,
"connectionId": "string"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}
payload
| Name | Type | Description |
|---|---|---|
| userDisconnected | object | - |
payload.userDisconnected
| Name | Type | Description |
|---|---|---|
| reason | string | - |
| code | integer | - |
| platform | string | - |
| lobbySessionId | string | - |
| isReconnecting | boolean | - |
| connectionId | string | - |
userChatRateLimited
Contains fields from event and the following payload.
Example value
{
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}
id
This is a free-form object.
version
This is a free-form object.
name
This is a free-form object.
namespace
This is a free-form object.
parentNamespace
This is a free-form object.
timestamp
This is a free-form object.
clientId
This is a free-form object.
userId
This is a free-form object.
traceId
This is a free-form object.
sessionId
This is a free-form object.
spanContext
This is a free-form object.
userRateLimited
Contains fields from event and the following payload.
Example value
{
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}
id
This is a free-form object.
version
This is a free-form object.
name
This is a free-form object.
namespace
This is a free-form object.
parentNamespace
This is a free-form object.
timestamp
This is a free-form object.
clientId
This is a free-form object.
userId
This is a free-form object.
traceId
This is a free-form object.
sessionId
This is a free-form object.
spanContext
This is a free-form object.
userBlockAdded
Contains fields from event and the following payload.
Example value
{
"payload": {
"blocked": {
"blockedByUserId": "string",
"blockedUserId": "string"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}
payload
| Name | Type | Description |
|---|---|---|
| blocked | userBlock | - |
userBlockRemoved
Contains fields from event and the following payload.
Example value
{
"payload": {
"blocked": {
"blockedByUserId": "string",
"blockedUserId": "string"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}
payload
| Name | Type | Description |
|---|---|---|
| blocked | userBlock | - |
concurrentConnectedUserStats
Contains fields from event and the following payload.
Example value
{
"payload": {
"totalConnectedUser": 0
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}
payload
| Name | Type | Description |
|---|---|---|
| totalConnectedUser | integer | - |
userRegistered
Contains fields from event and the following payload.
Example value
{
"payload": {
"userRegistered": {
"platform": "99233068-314d-4011-ad10-c262f1850269",
"lobbySessionId": "37512dc3-c3f3-4f61-9822-08a8561869f6"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}
payload
| Name | Type | Description |
|---|---|---|
| userRegistered | object | - |
payload.userRegistered
| Name | Type | Description |
|---|---|---|
| platform | string (uuid) | - |
| lobbySessionId | string (uuid) | - |
userUnregistered
Contains fields from event and the following payload.
Example value
{
"payload": {
"userUnregistered": {
"platform": "99233068-314d-4011-ad10-c262f1850269",
"lobbySessionId": "37512dc3-c3f3-4f61-9822-08a8561869f6",
"code": 0
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}
payload
| Name | Type | Description |
|---|---|---|
| userUnregistered | object | - |
payload.userUnregistered
| Name | Type | Description |
|---|---|---|
| platform | string (uuid) | - |
| lobbySessionId | string (uuid) | - |
| code | integer | - |
Published Messages (userBlocked)
The service publishes one of these messages below.
userBlockAdded
Contains fields from event and the following payload.
Example value
{
"payload": {
"blocked": {
"blockedByUserId": "string",
"blockedUserId": "string"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}
payload
| Name | Type | Description |
|---|---|---|
| blocked | userBlock | - |
userBlockRemoved
Contains fields from event and the following payload.
Example value
{
"payload": {
"blocked": {
"blockedByUserId": "string",
"blockedUserId": "string"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}
payload
| Name | Type | Description |
|---|---|---|
| blocked | userBlock | - |
Published Messages (lobbyMatchmakingTickets)
The service publishes one of these messages below.
matchmakingTicketsPublished
Contains fields from event and the following payload.
Example value
{
"payload": {
"totalMatchmakingRequest": 0,
"averageMatchmakingExecutionTime": 0
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}
payload
| Name | Type | Description |
|---|---|---|
| totalMatchmakingRequest | integer | - |
| averageMatchmakingExecutionTime | integer | - |
Published Messages (lobbyTotalUsersOnline)
The service publishes one of these messages below.
totalUsersOnlinePublished
Contains fields from event and the following payload.
Example value
{
"payload": {
"totalUsersOnline": 0,
"totalUsersOnlineSteam": 0,
"totalUsersOnlineXbox": 0,
"totalUsersOnlinePlaystation": 0
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}
payload
| Name | Type | Description |
|---|---|---|
| totalUsersOnline | integer | - |
| totalUsersOnlineSteam | integer | - |
| totalUsersOnlineXbox | integer | - |
| totalUsersOnlinePlaystation | integer | - |
Schemas
userBlock
| Name | Type | Description |
|---|---|---|
| blockedByUserId | string | - |
| blockedUserId | string | - |
event
| Name | Type | Description |
|---|---|---|
| id | string | - |
| version | integer | - |
| name | string | - |
| namespace | string | - |
| parentNamespace | string | - |
| timestamp | string (date-time) | - |
| clientId | string | - |
| userId | string | UserId of the operator for this event (optional) |
| traceId | string | - |
| sessionId | string | - |
| spanContext | string | - |