sharedlibrarycoreinterfaces IGameLogReader - RaidMax/IW4M-Admin GitHub Wiki

IGameLogReader Public interface

Description

represents the abstraction of game log reading

Diagram

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

Members

Properties

Public properties

Type Name Methods
long Length
how long the log file is		 get
int UpdateInterval
how often to poll the log file		 get

Methods

Public methods

Returns Name
Task<IEnumerable<GameEvent>> ReadEventsFromLog(long fileSizeDiff, long startPosition, Server server)
get new events that have occured since the last poll

Details

Summary

represents the abstraction of game log reading

Methods

ReadEventsFromLog

Source code

public Task<IEnumerable<GameEvent>> ReadEventsFromLog(long fileSizeDiff, long startPosition, Server server)
Arguments
Type Name Description
long fileSizeDiff
long startPosition
Server server
Summary

get new events that have occured since the last poll

Returns

Properties

Length

public long Length { get; }
Summary

how long the log file is

UpdateInterval

public int UpdateInterval { get; }
Summary

how often to poll the log file

Generated with ModularDoc

Discord

ko-fi

⚠️ **GitHub.com Fallback** ⚠️