Static Public Member Functions
static bool	IsBackendEnabled ()

static bool	IsBackendReady ()

static bool	IsAuthenticated ()

static void	RefreshPing ()
	---> This is the function to call if you want to update the connection state <— Refresh ping value - won't do anything if is already pinging and waiting for the result

static void	ClearRefreshQueue ()

static SCR_ECommStatus	GetLastReceivedCommStatus ()

static int	GetPingValue ()
	Return ping value.

static int	GetPingAge ()
	Return the last ping's age in milliseconds.

static bool	CanRefresh ()

static bool	IsInRefreshCooldown ()

static bool	IsPingingStuck ()

static void	RefreshStatuses ()

static ServiceStatusItem	GetMainStatus ()

static ServiceStatusItem	GetStatusByName (string statusName)
	finds a service by name

static void	GetStatuses (notnull array< ServiceStatusItem > statuses)

static bool	AreServicesReady ()

static int	GetStatusesAge ()
	Return statuses age IN SECONDS.

static bool	DisplayServiceOnCurrentPlatform (SCR_BackendServiceDisplay service)

static bool	IsServiceActive (string serviceName)

static bool	AreMultiplayerServicesAvailable ()

static bool	IsBackendConnectionAvailable ()

static ScriptInvokerCommStatus	GetOnCommStatusCheckFinished ()

static ScriptInvokerVoid	GetOnCommStatusCheckStart ()

static void	DEBUG ()

Static Public Attributes
static const int	REFRESH_COOLDOWN = 10000

static const int	CONNECTION_CHECK_EXPIRE_TIME = 15000

static const int	AUTOMATIC_REFRESH_RATE = 60000

static const string	STATUS_OK = "ok"

static const string	STATUS_ERROR = "error"

static const string	SERVICE_ACCOUNT_PROFILE = "game-identity"

static const string	SERVICE_XBOX = "game-identity"

static const string	SERVICE_BI_BACKEND_MULTIPLAYER = "game-api"

static const string	SERVICE_WORKSHOP = "reforger-workshop-api"

static const int	PING_MAX = 999

static const int	PING_THRESHOLD_GOOD = 100

static const int	PING_THRESHOLD_BAD = 300

static const int	PING_THRESHOLD_AWFUL = 600

Static Protected Member Functions
static bool	IsPinging ()

static void	RefreshPing_Internal ()

static void	StartStatusCheck ()

static void	CheckStatus ()

static void	CheckCommStatus ()

static void	CheckBackendStatus ()

Static Protected Attributes
static int	s_iLastPingUpdate = -1

static int	s_iLastStatusUpdate = -1

static ServiceStatusItem	s_MainStatus

static const ref array< ServiceStatusItem >	SERVICE_STATUSES = {}

static const int	COMM_STATUS_CHECK_FREQUENCY_MS = 500

static const int	FIRST_REFRESH_DELAY = 1000

static SCR_ECommStatus	s_eLastReceivedCommStatus = SCR_ECommStatus.RUNNING

static bool	s_bIsCheckingCommStatus

static float	s_fLastReceivedCommResponseTime

static float	s_fPingStartTime

static bool	s_bFirstRefresh = true

static ref ScriptInvokerCommStatus	s_OnCommStatusCheckFinished

static ref ScriptInvokerVoid	s_OnCommStatusCheckStart

Member Function Documentation

◆ AreMultiplayerServicesAvailable()

static bool SCR_ServicesStatusHelper.AreMultiplayerServicesAvailable ( )

static

Returns

◆ AreServicesReady()

static bool SCR_ServicesStatusHelper.AreServicesReady ( )

static

Returns

◆ CanRefresh()

static bool SCR_ServicesStatusHelper.CanRefresh ( )

static

Returns

◆ CheckBackendStatus()

static void SCR_ServicesStatusHelper.CheckBackendStatus ( )

staticprotected

◆ CheckCommStatus()

static void SCR_ServicesStatusHelper.CheckCommStatus ( )

staticprotected

◆ CheckStatus()

static void SCR_ServicesStatusHelper.CheckStatus ( )

staticprotected

◆ ClearRefreshQueue()

static void SCR_ServicesStatusHelper.ClearRefreshQueue ( )

static

◆ DEBUG()

static void SCR_ServicesStatusHelper.DEBUG ( )

static

◆ DisplayServiceOnCurrentPlatform()

static bool SCR_ServicesStatusHelper.DisplayServiceOnCurrentPlatform ( SCR_BackendServiceDisplay service )

static

Parameters

[in] service

Returns

◆ GetLastReceivedCommStatus()

static SCR_ECommStatus SCR_ServicesStatusHelper.GetLastReceivedCommStatus ( )

static

Returns

◆ GetMainStatus()

static ServiceStatusItem SCR_ServicesStatusHelper.GetMainStatus ( )

static

Returns

◆ GetOnCommStatusCheckFinished()

static ScriptInvokerCommStatus SCR_ServicesStatusHelper.GetOnCommStatusCheckFinished ( )

static

Returns

◆ GetOnCommStatusCheckStart()

static ScriptInvokerVoid SCR_ServicesStatusHelper.GetOnCommStatusCheckStart ( )

static

Returns

◆ GetPingAge()

static int SCR_ServicesStatusHelper.GetPingAge ( )

static

Return the last ping's age in milliseconds.

◆ GetPingValue()

static int SCR_ServicesStatusHelper.GetPingValue ( )

static

Return ping value.

Returns: ping in milliseconds

◆ GetStatusByName()

static ServiceStatusItem SCR_ServicesStatusHelper.GetStatusByName ( string statusName )

static

finds a service by name

Parameters

statusName name of the wanted status, case INsensitive

◆ GetStatuses()

static void SCR_ServicesStatusHelper.GetStatuses ( notnull array< ServiceStatusItem > statuses )

static

Parameters

[in] statuses

◆ GetStatusesAge()

static int SCR_ServicesStatusHelper.GetStatusesAge ( )

static

Return statuses age IN SECONDS.

◆ IsAuthenticated()

static bool SCR_ServicesStatusHelper.IsAuthenticated ( )

static

Returns

◆ IsBackendConnectionAvailable()

static bool SCR_ServicesStatusHelper.IsBackendConnectionAvailable ( )

static

Returns

◆ IsBackendEnabled()

static bool SCR_ServicesStatusHelper.IsBackendEnabled ( )

static

Returns

◆ IsBackendReady()

static bool SCR_ServicesStatusHelper.IsBackendReady ( )

static

Returns

◆ IsInRefreshCooldown()

static bool SCR_ServicesStatusHelper.IsInRefreshCooldown ( )

static

Returns

◆ IsPinging()

static bool SCR_ServicesStatusHelper.IsPinging ( )

staticprotected

Returns

◆ IsPingingStuck()

static bool SCR_ServicesStatusHelper.IsPingingStuck ( )

static

Returns

◆ IsServiceActive()

static bool SCR_ServicesStatusHelper.IsServiceActive ( string serviceName )

static

Parameters

[in] serviceName

Returns

◆ RefreshPing()

static void SCR_ServicesStatusHelper.RefreshPing ( )

static

---> This is the function to call if you want to update the connection state <— Refresh ping value - won't do anything if is already pinging and waiting for the result

◆ RefreshPing_Internal()

static void SCR_ServicesStatusHelper.RefreshPing_Internal ( )

staticprotected

◆ RefreshStatuses()

static void SCR_ServicesStatusHelper.RefreshStatuses ( )

static

◆ StartStatusCheck()

static void SCR_ServicesStatusHelper.StartStatusCheck ( )

staticprotected

Member Data Documentation

◆ AUTOMATIC_REFRESH_RATE

const int SCR_ServicesStatusHelper.AUTOMATIC_REFRESH_RATE = 60000

static

◆ COMM_STATUS_CHECK_FREQUENCY_MS

const int SCR_ServicesStatusHelper.COMM_STATUS_CHECK_FREQUENCY_MS = 500

staticprotected

◆ CONNECTION_CHECK_EXPIRE_TIME

const int SCR_ServicesStatusHelper.CONNECTION_CHECK_EXPIRE_TIME = 15000

static

◆ FIRST_REFRESH_DELAY

const int SCR_ServicesStatusHelper.FIRST_REFRESH_DELAY = 1000

staticprotected

◆ PING_MAX

const int SCR_ServicesStatusHelper.PING_MAX = 999

static

◆ PING_THRESHOLD_AWFUL

const int SCR_ServicesStatusHelper.PING_THRESHOLD_AWFUL = 600

static

◆ PING_THRESHOLD_BAD

const int SCR_ServicesStatusHelper.PING_THRESHOLD_BAD = 300

static

◆ PING_THRESHOLD_GOOD

const int SCR_ServicesStatusHelper.PING_THRESHOLD_GOOD = 100

static

◆ REFRESH_COOLDOWN

const int SCR_ServicesStatusHelper.REFRESH_COOLDOWN = 10000

static

◆ s_bFirstRefresh

bool SCR_ServicesStatusHelper.s_bFirstRefresh = true

staticprotected

◆ s_bIsCheckingCommStatus

bool SCR_ServicesStatusHelper.s_bIsCheckingCommStatus

staticprotected

◆ s_eLastReceivedCommStatus

SCR_ECommStatus SCR_ServicesStatusHelper.s_eLastReceivedCommStatus = SCR_ECommStatus.RUNNING

staticprotected

◆ s_fLastReceivedCommResponseTime

float SCR_ServicesStatusHelper.s_fLastReceivedCommResponseTime

staticprotected

◆ s_fPingStartTime

float SCR_ServicesStatusHelper.s_fPingStartTime

staticprotected

◆ s_iLastPingUpdate

int SCR_ServicesStatusHelper.s_iLastPingUpdate = -1

staticprotected

◆ s_iLastStatusUpdate

int SCR_ServicesStatusHelper.s_iLastStatusUpdate = -1

staticprotected

◆ s_MainStatus

ServiceStatusItem SCR_ServicesStatusHelper.s_MainStatus

staticprotected

◆ s_OnCommStatusCheckFinished

ref ScriptInvokerCommStatus SCR_ServicesStatusHelper.s_OnCommStatusCheckFinished

staticprotected

◆ s_OnCommStatusCheckStart

ref ScriptInvokerVoid SCR_ServicesStatusHelper.s_OnCommStatusCheckStart

staticprotected

◆ SERVICE_ACCOUNT_PROFILE

const string SCR_ServicesStatusHelper.SERVICE_ACCOUNT_PROFILE = "game-identity"

static

◆ SERVICE_BI_BACKEND_MULTIPLAYER

const string SCR_ServicesStatusHelper.SERVICE_BI_BACKEND_MULTIPLAYER = "game-api"

static

◆ SERVICE_STATUSES

const ref array<ServiceStatusItem> SCR_ServicesStatusHelper.SERVICE_STATUSES = {}

staticprotected

◆ SERVICE_WORKSHOP

const string SCR_ServicesStatusHelper.SERVICE_WORKSHOP = "reforger-workshop-api"

static

◆ SERVICE_XBOX

const string SCR_ServicesStatusHelper.SERVICE_XBOX = "game-identity"

static

◆ STATUS_ERROR

const string SCR_ServicesStatusHelper.STATUS_ERROR = "error"

static

◆ STATUS_OK

const string SCR_ServicesStatusHelper.STATUS_OK = "ok"

static

The documentation for this interface was generated from the following file:

Game/Helpers/SCR_ServicesStatusHelper.c

Static Public Member Functions

Static Public Attributes

Static Protected Member Functions

Static Protected Attributes

Member Function Documentation

◆ AreMultiplayerServicesAvailable()

◆ AreServicesReady()

◆ CanRefresh()

◆ CheckBackendStatus()

◆ CheckCommStatus()

◆ CheckStatus()

◆ ClearRefreshQueue()

◆ DEBUG()

◆ DisplayServiceOnCurrentPlatform()

◆ GetLastReceivedCommStatus()

◆ GetMainStatus()

◆ GetOnCommStatusCheckFinished()

◆ GetOnCommStatusCheckStart()

◆ GetPingAge()

◆ GetPingValue()

◆ GetStatusByName()

◆ GetStatuses()

◆ GetStatusesAge()

◆ IsAuthenticated()

◆ IsBackendConnectionAvailable()

◆ IsBackendEnabled()

◆ IsBackendReady()

◆ IsInRefreshCooldown()

◆ IsPinging()

◆ IsPingingStuck()

◆ IsServiceActive()

◆ RefreshPing()

◆ RefreshPing_Internal()

◆ RefreshStatuses()

◆ StartStatusCheck()

Member Data Documentation

◆ AUTOMATIC_REFRESH_RATE

◆ COMM_STATUS_CHECK_FREQUENCY_MS

◆ CONNECTION_CHECK_EXPIRE_TIME

◆ FIRST_REFRESH_DELAY

◆ PING_MAX

◆ PING_THRESHOLD_AWFUL

◆ PING_THRESHOLD_BAD

◆ PING_THRESHOLD_GOOD

◆ REFRESH_COOLDOWN

◆ s_bFirstRefresh

◆ s_bIsCheckingCommStatus

◆ s_eLastReceivedCommStatus

◆ s_fLastReceivedCommResponseTime

◆ s_fPingStartTime

◆ s_iLastPingUpdate

◆ s_iLastStatusUpdate

◆ s_MainStatus

◆ s_OnCommStatusCheckFinished

◆ s_OnCommStatusCheckStart

◆ SERVICE_ACCOUNT_PROFILE

◆ SERVICE_BI_BACKEND_MULTIPLAYER

◆ SERVICE_STATUSES

◆ SERVICE_WORKSHOP

◆ SERVICE_XBOX

◆ STATUS_ERROR

◆ STATUS_OK