PipelinePackBase<TConnector>

Base class for simple pipeline effect packs.

Kind: Abstract class

Namespace: CrowdControl.Games

Inheritance: EffectPack\<TConnector\> → IDisposable → IEffectPack → IEffectPack → IEffectPack\<TConnector\>

Public Member Functions

Task

CheckVersion()

bool

ValidateRemoteVersion()

Validates the remote version against the required version.

virtual override

bool

StopAllEffects()

bool

HashCompare(string hash, string comparand)

Compares two hashes to see if they are equal.

string

HashString(string message)

Hashes a string using the algorithm specified by CrowdControl.Games.PipelinePackBase<1.AuthenticationHashMode.

virtual

void

OnMessageParsed(IPipelineConnector simpleTCPConnector, SimpleJSONResponse response, IConnectionContext connectionContext)

Handles the parsing of a message received from the game.

Public Static Functions

bool

HashCompare(string hash, string comparand, DigestAlgorithmType digestAlgorithm)

Compares two hashes to see if they are equal.

string

HashString(string message, DigestAlgorithmType digestAlgorithm)

Hashes a string using the algorithm specified by CrowdControl.Games.PipelinePackBase<1.AuthenticationHashMode.

Properties

AuthenticationStateType

AuthenticationState

[get, set]

SITimeSpan

MinimumRequestInterval

[get, set]

The minimum interval between requests to the game.

RpcTarget?

DefaultGameRpcTarget

[get, ]

The default RPC target for game requests.

VersionNumber

RemoteVersion

[get, ]

VersionNumber

RequireVersion

[get, ]

VersionCheckBehavior

VersionCheckBehavior

[get, ]

IGUIProvider

GUIProvider

[get, set]

AuthenticationType

AuthenticationMode

[get, ]

DigestAlgorithmType

AuthenticationHashMode

[get, ]

TextEncoding

Encoding

[get, ]

MessageFormatType

MessageFormat

[get, ]

The format of the message.

QuantityFormatType

QuantityFormat

[get, ]

The format of the quantity parameter.

SITimeSpan

ResponseTimeout

[get, ]

bool

RemoteScheduler

[get, ]

true the game/plugin performs its own scheduling; otherwise, false.

FunctionSet

RemoteFunctions

[get, ]

Represents a set of remote game functions that can be called.

Events

EventHandler<AuthenticationStateType>

AuthenticationStateChanged

Action<VersionNumber>

RemoteVersionReceived