Skip to main content

Lobby Server 0.1.0 documentation

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

NameTypeDescription
userConnectedobject-
payload.userConnected
NameTypeDescription
lobbySessionIdstring-
lobbyLoginTypestring* 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

NameTypeDescription
userDisconnectedobject-
payload.userDisconnected
NameTypeDescription
reasonstring-
codeinteger-
platformstring-
lobbySessionIdstring-
isReconnectingboolean-
connectionIdstring-

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

NameTypeDescription
blockeduserBlock-

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

NameTypeDescription
blockeduserBlock-

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

NameTypeDescription
totalConnectedUserinteger-

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

NameTypeDescription
userRegisteredobject-
payload.userRegistered
NameTypeDescription
platformstring (uuid)-
lobbySessionIdstring (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

NameTypeDescription
userUnregisteredobject-
payload.userUnregistered
NameTypeDescription
platformstring (uuid)-
lobbySessionIdstring (uuid)-
codeinteger-

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

NameTypeDescription
blockeduserBlock-

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

NameTypeDescription
blockeduserBlock-

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

NameTypeDescription
totalMatchmakingRequestinteger-
averageMatchmakingExecutionTimeinteger-

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

NameTypeDescription
totalUsersOnlineinteger-
totalUsersOnlineSteaminteger-
totalUsersOnlineXboxinteger-
totalUsersOnlinePlaystationinteger-

Schemas

userBlock

NameTypeDescription
blockedByUserIdstring-
blockedUserIdstring-

event

NameTypeDescription
idstring-
versioninteger-
namestring-
namespacestring-
parentNamespacestring-
timestampstring (date-time)-
clientIdstring-
userIdstringUserId of the operator for this event (optional)
traceIdstring-
sessionIdstring-
spanContextstring-