1 sharedlibrarycoreinterfaces IServerDataViewer
RaidMax edited this page 2023-05-20 22:09:21 -05:00

IServerDataViewer Public interface

Description

Exposes methods to get analytical data about server(s)

Diagram

  flowchart LR
  classDef interfaceStyle stroke-dasharray: 5 5;
  classDef abstractStyle stroke-width:4px
  subgraph SharedLibraryCore.Interfaces
  SharedLibraryCore.Interfaces.IServerDataViewer[[IServerDataViewer]]
  class SharedLibraryCore.Interfaces.IServerDataViewer interfaceStyle;
  end

Members

Methods

Public methods

Returns Name
Task<(int Item1, int Item2)> ClientCountsAsync(Nullable<TimeSpan> overPeriod, Nullable<Game> gameCode, CancellationToken token)
Task<IEnumerable<ClientHistoryInfo>> ClientHistoryAsync(Nullable<TimeSpan> overPeriod, CancellationToken token)
Task<(Nullable<int> Item1, Nullable<DateTime> Item2)> MaxConcurrentClientsAsync(Nullable<long> serverId, Nullable<Game> gameCode, Nullable<TimeSpan> overPeriod, CancellationToken token)
Task<int> RankedClientsCountAsync(Nullable<long> serverId, CancellationToken token)

Details

Summary

Exposes methods to get analytical data about server(s)

Methods

MaxConcurrentClientsAsync

Source code

public Task<(Nullable<int> Item1, Nullable<DateTime> Item2)> MaxConcurrentClientsAsync(Nullable<long> serverId, Nullable<Game> gameCode, Nullable<TimeSpan> overPeriod, CancellationToken token)
Arguments
Type Name Description
Nullable<long> serverId
Nullable<Game> gameCode
Nullable<TimeSpan> overPeriod
CancellationToken token

ClientCountsAsync

Source code

public Task<(int Item1, int Item2)> ClientCountsAsync(Nullable<TimeSpan> overPeriod, Nullable<Game> gameCode, CancellationToken token)
Arguments
Type Name Description
Nullable<TimeSpan> overPeriod
Nullable<Game> gameCode
CancellationToken token

ClientHistoryAsync

Source code

public Task<IEnumerable<ClientHistoryInfo>> ClientHistoryAsync(Nullable<TimeSpan> overPeriod, CancellationToken token)
Arguments
Type Name Description
Nullable<TimeSpan> overPeriod
CancellationToken token

RankedClientsCountAsync

Source code

public Task<int> RankedClientsCountAsync(Nullable<long> serverId, CancellationToken token)
Arguments
Type Name Description
Nullable<long> serverId
CancellationToken token

Generated with ModularDoc