C# Class Stumps.StumpsServer

A class that represents a Stumps server.
Inheritance: IStumpsServer
Show file Open project: Cayan-LLC/stumps Class Usage Examples

Public Methods

Method Description
AddNewStump ( string stumpId ) : Stump

Adds a new T:Stumps.Stump with a specified identifier to the collection.

AddStump ( Stump stump ) : void

Adds a new T:Stumps.Stump to the collection.

DeleteStump ( string stumpId ) : void

Deletes the specified stump from the collection.

Dispose ( ) : void

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

FindStump ( string stumpId ) : Stump

Finds an existing stump.

A null value is returned if a Stump is not found.

Shutdown ( ) : void

Stops this instance of the Stumps server.

Start ( ) : void

Starts this instance of the Stumps server.

StumpsServer ( ) : System

Initializes a new instance of the T:Stumps.StumpsServer class.

Private Methods

Method Description
ServerRequestFinished ( object sender, StumpsContextEventArgs e ) : void

Handles the requestFinishing event of the server instance.

ServerRequestProcessed ( object sender, StumpsContextEventArgs e ) : void

Handles the RequestProcessed event of the server instance.

ServerRequestStarted ( object sender, StumpsContextEventArgs e ) : void

Handles the RequestStarted event of the server instance.

UpdateStumpsEnabledFlag ( bool enabled ) : void

Updates the enabled flag of the Stumps handler.

Method Details

AddNewStump() public method

Adds a new T:Stumps.Stump with a specified identifier to the collection.
is null. A with the same identifier already exists.
public AddNewStump ( string stumpId ) : Stump
stumpId string The unique identifier for the .
return Stump

AddStump() public method

Adds a new T:Stumps.Stump to the collection.
is null. A with the same identifier already exists.
public AddStump ( Stump stump ) : void
stump Stump The to add to the collection.
return void

DeleteStump() public method

Deletes the specified stump from the collection.
public DeleteStump ( string stumpId ) : void
stumpId string The unique identifier for the stump to remove.
return void

Dispose() public method

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
public Dispose ( ) : void
return void

FindStump() public method

Finds an existing stump.
A null value is returned if a Stump is not found.
public FindStump ( string stumpId ) : Stump
stumpId string The unique identifier for the Stump.
return Stump

Shutdown() public method

Stops this instance of the Stumps server.
public Shutdown ( ) : void
return void

Start() public method

Starts this instance of the Stumps server.
public Start ( ) : void
return void

StumpsServer() public method

Initializes a new instance of the T:Stumps.StumpsServer class.
public StumpsServer ( ) : System
return System