Arma Reforger Explorer 1.7.0.54
Arma Reforger Code Explorer by Zeroy - Thanks to MisterOutofTime
Loading...
Searching...
No Matches
SCR_ServicesStatusHelper Class Reference

Static Protected Member Functions

static bool IsBackendEnabled ()
static bool IsBackendReady ()
static bool IsAuthenticated ()
static bool IsPinging ()
static void RefreshPing ()
static void RefreshPing_Internal ()
static void StartStatusCheck ()
static void CheckStatus ()
static void CheckCommStatus ()
static void CheckBackendStatus ()
static void ClearRefreshQueue ()
static SCR_ECommStatus GetLastReceivedCommStatus ()
static int GetPingValue ()
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)
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 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 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 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

Detailed Description

Definition at line 15 of file SCR_ServicesStatusHelper.c.

Member Function Documentation

◆ AreMultiplayerServicesAvailable()

bool SCR_ServicesStatusHelper::AreMultiplayerServicesAvailable ( )
inlinestaticprotected
Returns

Definition at line 406 of file SCR_ServicesStatusHelper.c.

◆ AreServicesReady()

bool SCR_ServicesStatusHelper::AreServicesReady ( )
inlinestaticprotected
Returns

Definition at line 336 of file SCR_ServicesStatusHelper.c.

◆ CanRefresh()

bool SCR_ServicesStatusHelper::CanRefresh ( )
inlinestaticprotected
Returns

Definition at line 250 of file SCR_ServicesStatusHelper.c.

◆ CheckBackendStatus()

void SCR_ServicesStatusHelper::CheckBackendStatus ( )
inlinestaticprotected

Definition at line 199 of file SCR_ServicesStatusHelper.c.

◆ CheckCommStatus()

void SCR_ServicesStatusHelper::CheckCommStatus ( )
inlinestaticprotected

Definition at line 166 of file SCR_ServicesStatusHelper.c.

◆ CheckStatus()

void SCR_ServicesStatusHelper::CheckStatus ( )
inlinestaticprotected

Definition at line 153 of file SCR_ServicesStatusHelper.c.

◆ ClearRefreshQueue()

void SCR_ServicesStatusHelper::ClearRefreshQueue ( )
inlinestaticprotected

Definition at line 216 of file SCR_ServicesStatusHelper.c.

◆ DEBUG()

void SCR_ServicesStatusHelper::DEBUG ( )
inlinestaticprotected

Definition at line 442 of file SCR_ServicesStatusHelper.c.

◆ DisplayServiceOnCurrentPlatform()

bool SCR_ServicesStatusHelper::DisplayServiceOnCurrentPlatform ( SCR_BackendServiceDisplay service)
inlinestaticprotected
Parameters
[in]service
Returns

Definition at line 355 of file SCR_ServicesStatusHelper.c.

◆ GetLastReceivedCommStatus()

SCR_ECommStatus SCR_ServicesStatusHelper::GetLastReceivedCommStatus ( )
inlinestaticprotected
Returns

Definition at line 223 of file SCR_ServicesStatusHelper.c.

◆ GetMainStatus()

ServiceStatusItem SCR_ServicesStatusHelper::GetMainStatus ( )
inlinestaticprotected
Returns

Definition at line 299 of file SCR_ServicesStatusHelper.c.

◆ GetOnCommStatusCheckFinished()

ScriptInvokerCommStatus SCR_ServicesStatusHelper::GetOnCommStatusCheckFinished ( )
inlinestaticprotected
Returns

Definition at line 422 of file SCR_ServicesStatusHelper.c.

◆ GetOnCommStatusCheckStart()

ScriptInvokerVoid SCR_ServicesStatusHelper::GetOnCommStatusCheckStart ( )
inlinestaticprotected
Returns

Definition at line 432 of file SCR_ServicesStatusHelper.c.

◆ GetPingAge()

int SCR_ServicesStatusHelper::GetPingAge ( )
inlinestaticprotected

Return the last ping's age in milliseconds.

Definition at line 241 of file SCR_ServicesStatusHelper.c.

◆ GetPingValue()

int SCR_ServicesStatusHelper::GetPingValue ( )
inlinestaticprotected

Return ping value

Returns
ping in milliseconds

Definition at line 231 of file SCR_ServicesStatusHelper.c.

◆ GetStatusByName()

ServiceStatusItem SCR_ServicesStatusHelper::GetStatusByName ( string statusName)
inlinestaticprotected

finds a service by name

Parameters
statusNamename of the wanted status, case INsensitive

Definition at line 307 of file SCR_ServicesStatusHelper.c.

◆ GetStatuses()

void SCR_ServicesStatusHelper::GetStatuses ( notnull array< ServiceStatusItem > statuses)
inlinestaticprotected
Parameters
[in]statuses

Definition at line 328 of file SCR_ServicesStatusHelper.c.

◆ GetStatusesAge()

int SCR_ServicesStatusHelper::GetStatusesAge ( )
inlinestaticprotected

Return statuses age IN SECONDS.

Definition at line 343 of file SCR_ServicesStatusHelper.c.

◆ IsAuthenticated()

bool SCR_ServicesStatusHelper::IsAuthenticated ( )
inlinestaticprotected
Returns

Definition at line 74 of file SCR_ServicesStatusHelper.c.

◆ IsBackendConnectionAvailable()

bool SCR_ServicesStatusHelper::IsBackendConnectionAvailable ( )
inlinestaticprotected
Returns

Definition at line 413 of file SCR_ServicesStatusHelper.c.

◆ IsBackendEnabled()

bool SCR_ServicesStatusHelper::IsBackendEnabled ( )
inlinestaticprotected
Returns

Definition at line 60 of file SCR_ServicesStatusHelper.c.

◆ IsBackendReady()

bool SCR_ServicesStatusHelper::IsBackendReady ( )
inlinestaticprotected
Returns

Definition at line 67 of file SCR_ServicesStatusHelper.c.

◆ IsInRefreshCooldown()

bool SCR_ServicesStatusHelper::IsInRefreshCooldown ( )
inlinestaticprotected
Returns

Definition at line 257 of file SCR_ServicesStatusHelper.c.

◆ IsPinging()

bool SCR_ServicesStatusHelper::IsPinging ( )
inlinestaticprotected
Returns

Definition at line 85 of file SCR_ServicesStatusHelper.c.

◆ IsPingingStuck()

bool SCR_ServicesStatusHelper::IsPingingStuck ( )
inlinestaticprotected
Returns

Definition at line 264 of file SCR_ServicesStatusHelper.c.

◆ IsServiceActive()

bool SCR_ServicesStatusHelper::IsServiceActive ( string serviceName)
inlinestaticprotected
Parameters
[in]serviceName
Returns

Definition at line 390 of file SCR_ServicesStatusHelper.c.

◆ RefreshPing()

void SCR_ServicesStatusHelper::RefreshPing ( )
inlinestaticprotected

---> 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

Definition at line 94 of file SCR_ServicesStatusHelper.c.

◆ RefreshPing_Internal()

void SCR_ServicesStatusHelper::RefreshPing_Internal ( )
inlinestaticprotected

Definition at line 127 of file SCR_ServicesStatusHelper.c.

◆ RefreshStatuses()

void SCR_ServicesStatusHelper::RefreshStatuses ( )
inlinestaticprotected

Definition at line 274 of file SCR_ServicesStatusHelper.c.

◆ StartStatusCheck()

void SCR_ServicesStatusHelper::StartStatusCheck ( )
inlinestaticprotected

Definition at line 141 of file SCR_ServicesStatusHelper.c.

Member Data Documentation

◆ AUTOMATIC_REFRESH_RATE

const int SCR_ServicesStatusHelper::AUTOMATIC_REFRESH_RATE = 60000
staticprotected

Definition at line 28 of file SCR_ServicesStatusHelper.c.

◆ COMM_STATUS_CHECK_FREQUENCY_MS

const int SCR_ServicesStatusHelper::COMM_STATUS_CHECK_FREQUENCY_MS = 500
staticprotected

Definition at line 23 of file SCR_ServicesStatusHelper.c.

◆ CONNECTION_CHECK_EXPIRE_TIME

const int SCR_ServicesStatusHelper::CONNECTION_CHECK_EXPIRE_TIME = 15000
staticprotected

Definition at line 27 of file SCR_ServicesStatusHelper.c.

◆ FIRST_REFRESH_DELAY

const int SCR_ServicesStatusHelper::FIRST_REFRESH_DELAY = 1000
staticprotected

Definition at line 24 of file SCR_ServicesStatusHelper.c.

◆ PING_MAX

const int SCR_ServicesStatusHelper::PING_MAX = 999
staticprotected

Definition at line 41 of file SCR_ServicesStatusHelper.c.

◆ PING_THRESHOLD_AWFUL

const int SCR_ServicesStatusHelper::PING_THRESHOLD_AWFUL = 600
staticprotected

Definition at line 44 of file SCR_ServicesStatusHelper.c.

◆ PING_THRESHOLD_BAD

const int SCR_ServicesStatusHelper::PING_THRESHOLD_BAD = 300
staticprotected

Definition at line 43 of file SCR_ServicesStatusHelper.c.

◆ PING_THRESHOLD_GOOD

const int SCR_ServicesStatusHelper::PING_THRESHOLD_GOOD = 100
staticprotected

Definition at line 42 of file SCR_ServicesStatusHelper.c.

◆ REFRESH_COOLDOWN

const int SCR_ServicesStatusHelper::REFRESH_COOLDOWN = 10000
staticprotected

Definition at line 26 of file SCR_ServicesStatusHelper.c.

◆ s_bFirstRefresh

bool SCR_ServicesStatusHelper::s_bFirstRefresh = true
staticprotected

Definition at line 52 of file SCR_ServicesStatusHelper.c.

◆ s_bIsCheckingCommStatus

bool SCR_ServicesStatusHelper::s_bIsCheckingCommStatus
staticprotected

Definition at line 47 of file SCR_ServicesStatusHelper.c.

◆ s_eLastReceivedCommStatus

SCR_ECommStatus SCR_ServicesStatusHelper::s_eLastReceivedCommStatus = SCR_ECommStatus.RUNNING
staticprotected

Definition at line 46 of file SCR_ServicesStatusHelper.c.

◆ s_fLastReceivedCommResponseTime

float SCR_ServicesStatusHelper::s_fLastReceivedCommResponseTime
staticprotected

Definition at line 48 of file SCR_ServicesStatusHelper.c.

◆ s_fPingStartTime

float SCR_ServicesStatusHelper::s_fPingStartTime
staticprotected

Definition at line 50 of file SCR_ServicesStatusHelper.c.

◆ s_iLastPingUpdate

int SCR_ServicesStatusHelper::s_iLastPingUpdate = -1
staticprotected

Definition at line 17 of file SCR_ServicesStatusHelper.c.

◆ s_iLastStatusUpdate

int SCR_ServicesStatusHelper::s_iLastStatusUpdate = -1
staticprotected

Definition at line 18 of file SCR_ServicesStatusHelper.c.

◆ s_MainStatus

ServiceStatusItem SCR_ServicesStatusHelper::s_MainStatus
staticprotected

Definition at line 19 of file SCR_ServicesStatusHelper.c.

◆ s_OnCommStatusCheckFinished

ref ScriptInvokerCommStatus SCR_ServicesStatusHelper::s_OnCommStatusCheckFinished
staticprotected

Definition at line 55 of file SCR_ServicesStatusHelper.c.

◆ s_OnCommStatusCheckStart

ref ScriptInvokerVoid SCR_ServicesStatusHelper::s_OnCommStatusCheckStart
staticprotected

Definition at line 56 of file SCR_ServicesStatusHelper.c.

◆ SERVICE_ACCOUNT_PROFILE

const string SCR_ServicesStatusHelper::SERVICE_ACCOUNT_PROFILE = "game-identity"
staticprotected

Definition at line 35 of file SCR_ServicesStatusHelper.c.

◆ SERVICE_BI_BACKEND_MULTIPLAYER

const string SCR_ServicesStatusHelper::SERVICE_BI_BACKEND_MULTIPLAYER = "game-api"
staticprotected

Definition at line 37 of file SCR_ServicesStatusHelper.c.

◆ SERVICE_STATUSES

const ref array<ServiceStatusItem> SCR_ServicesStatusHelper::SERVICE_STATUSES = {}
staticprotected

Definition at line 20 of file SCR_ServicesStatusHelper.c.

◆ SERVICE_WORKSHOP

const string SCR_ServicesStatusHelper::SERVICE_WORKSHOP = "reforger-workshop-api"
staticprotected

Definition at line 38 of file SCR_ServicesStatusHelper.c.

◆ SERVICE_XBOX

const string SCR_ServicesStatusHelper::SERVICE_XBOX = "game-identity"
staticprotected

Definition at line 36 of file SCR_ServicesStatusHelper.c.

◆ STATUS_ERROR

const string SCR_ServicesStatusHelper::STATUS_ERROR = "error"
staticprotected

Definition at line 32 of file SCR_ServicesStatusHelper.c.

◆ STATUS_OK

const string SCR_ServicesStatusHelper::STATUS_OK = "ok"
staticprotected

Definition at line 31 of file SCR_ServicesStatusHelper.c.

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