1 iw4madminapplicationrconparsers BaseRConParser

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

Table of Contents

• BaseRConParser Public class
• Diagram
• Members
• Properties
• Public properties
• Methods
• Public methods
• Internal Static methods
• Details
• Inheritance
• Constructors
• BaseRConParser
• Arguments
• Methods
• ExecuteCommandAsync
• Arguments
• GetDvarAsync
• Arguments
• BeginGetDvar
• Arguments
• GetStatusAsync
• Arguments
• SetDvarAsync
• Arguments
• BeginSetDvar
• Arguments
• GetOverrideDvarName
• Arguments
• GetDefaultDvarValue
• Arguments
• OverrideTimeoutForCommand
• Arguments
• g__RemoveTrailingColorCode|32_0
• Arguments
• Properties
• Configuration
• Version
• GameName
• CanGenerateLogPath
• Name
• RConEngine
• IsOneLog

BaseRConParser Public class

Diagram

  flowchart LR
  classDef interfaceStyle stroke-dasharray: 5 5;
  classDef abstractStyle stroke-width:4px
  subgraph IW4MAdmin.Application.RConParsers
  IW4MAdmin.Application.RConParsers.BaseRConParser[[BaseRConParser]]
  end
  subgraph SharedLibraryCore.Interfaces
  SharedLibraryCore.Interfaces.IRConParser[[IRConParser]]
  class SharedLibraryCore.Interfaces.IRConParser interfaceStyle;
  end
SharedLibraryCore.Interfaces.IRConParser --> IW4MAdmin.Application.RConParsers.BaseRConParser

Members

Properties

Public properties

Type	Name	Methods
bool	CanGenerateLogPath	get, set
IRConParserConfiguration	Configuration	get, set
Game	GameName	get, set
bool	IsOneLog	get, set
string	Name	get, set
string	RConEngine	get, set
string	Version	get, set

Methods

Public methods

Returns	Name
void	BeginGetDvar(IRConConnection connection, string dvarName, AsyncCallback callback, CancellationToken token)
void	BeginSetDvar(IRConConnection connection, string dvarName, object dvarValue, AsyncCallback callback, CancellationToken token)
Task<string``[]>	ExecuteCommandAsync(IRConConnection connection, string command, CancellationToken token)
T	GetDefaultDvarValue(string dvarName)
Task<Dvar<T>>	GetDvarAsync(IRConConnection connection, string dvarName, T fallbackValue, CancellationToken token)
string	GetOverrideDvarName(string dvarName)
Task<IStatusResponse>	GetStatusAsync(IRConConnection connection, CancellationToken token)
Nullable<TimeSpan>	OverrideTimeoutForCommand(string command)
Task<bool>	SetDvarAsync(IRConConnection connection, string dvarName, object dvarValue, CancellationToken token)

Internal Static methods

Returns	Name
string	[`g__RemoveTrailingColorCode

Details

Inheritance

• IRConParser

Constructors

BaseRConParser

Source code

public BaseRConParser(ILogger<BaseRConParser> logger, IParserRegexFactory parserRegexFactory)

Arguments

Type	Name	Description
ILogger<BaseRConParser>	logger
IParserRegexFactory	parserRegexFactory

Methods

ExecuteCommandAsync

public virtual async Task<string> ExecuteCommandAsync(IRConConnection connection, string command, CancellationToken token)

Arguments

Type	Name	Description
IRConConnection	connection
string	command
CancellationToken	token

GetDvarAsync

public virtual async Task<Dvar<T>> GetDvarAsync<T>(IRConConnection connection, string dvarName, T fallbackValue, CancellationToken token)
where T : 

Arguments

Type	Name	Description
IRConConnection	connection
string	dvarName
T	fallbackValue
CancellationToken	token

BeginGetDvar

Source code

public void BeginGetDvar(IRConConnection connection, string dvarName, AsyncCallback callback, CancellationToken token)

Arguments

Type	Name	Description
IRConConnection	connection
string	dvarName
AsyncCallback	callback
CancellationToken	token

GetStatusAsync

public virtual async Task<IStatusResponse> GetStatusAsync(IRConConnection connection, CancellationToken token)

Arguments

Type	Name	Description
IRConConnection	connection
CancellationToken	token

SetDvarAsync

public virtual async Task<bool> SetDvarAsync(IRConConnection connection, string dvarName, object dvarValue, CancellationToken token)

Arguments

Type	Name	Description
IRConConnection	connection
string	dvarName
object	dvarValue
CancellationToken	token

BeginSetDvar

Source code

public void BeginSetDvar(IRConConnection connection, string dvarName, object dvarValue, AsyncCallback callback, CancellationToken token)

Arguments

Type	Name	Description
IRConConnection	connection
string	dvarName
object	dvarValue
AsyncCallback	callback
CancellationToken	token

GetOverrideDvarName

Source code

public virtual string GetOverrideDvarName(string dvarName)

Arguments

Type	Name	Description
string	dvarName

GetDefaultDvarValue

Source code

public virtual T GetDefaultDvarValue<T>(string dvarName)
where T : 

Arguments

Type	Name	Description
string	dvarName

OverrideTimeoutForCommand

Source code

public virtual Nullable<TimeSpan> OverrideTimeoutForCommand(string command)

Arguments

Type	Name	Description
string	command

g__RemoveTrailingColorCode|32_0

Source code

internal static string <GetDvarAsync>g__RemoveTrailingColorCode|32_0<T>(string input)
where T : 

Arguments

Type	Name	Description
string	input

Properties

Configuration

public virtual IRConParserConfiguration Configuration { get; set; }

Version

public virtual string Version { get; set; }

GameName

public Game GameName { get; set; }

CanGenerateLogPath

public bool CanGenerateLogPath { get; set; }

Name

public string Name { get; set; }

RConEngine

public string RConEngine { get; set; }

IsOneLog

public bool IsOneLog { get; set; }

Generated with ModularDoc

• Overview
• Getting Started
• FAQ
• Knowledge Base
• Features
  • Commands
  • Webfront
  • Game Interface
  • Permission Sets
  • Plugins
  • API
  • Searching
• Plugin Development
  • Examples
• Configuration
• Game Log Server