C# Class Stumps.Server.StumpsServerInstance

A class that represents an the environment and configuration of a Stumps server.
Inheritance: IDisposable
Afficher le fichier Open project: Cayan-LLC/stumps Class Usage Examples

Méthodes publiques

Méthode Description
CreateStump ( StumpContract contract ) : StumpContract

Creates a new Stump.
DeleteStump ( string stumpId ) : void

Deletes an existing stump.
Dispose ( ) : void

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
FindAllContracts ( ) : IList

Finds a list of all Stump contracts.
FindStump ( string stumpId ) : StumpContract

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.
StumpNameExists ( string stumpName ) : bool

Determines if a stump with the specified name exists.
StumpsServerInstance ( IServerFactory serverFactory, string serverId, IDataAccess dataAccess ) : System

Initializes a new instance of the T:Stumps.Server.StumpsServerInstance class.

Méthodes protégées

Méthode Description
Dispose ( bool disposing ) : void

Releases unmanaged and - optionally - managed resources.

Private Methods

Méthode Description
InitializeServer ( ) : void

Initializes the Stumps server controlled by this instance.
InitializeStumps ( ) : void

Initializes the Stumps for the server.
UnwrapAndAddStump ( StumpContract contract ) : void

Loads a stump from a specified T:Stumps.Server.StumpContract.

Method Details

CreateStump() public méthode

Creates a new Stump.
is null. A stump with the same name already exists.
public CreateStump ( StumpContract contract ) : StumpContract
contract StumpContract The contract used to create the Stump.
Résultat StumpContract

DeleteStump() public méthode

Deletes an existing stump.
public DeleteStump ( string stumpId ) : void
stumpId string The unique identifier for the Stump.
Résultat void

Dispose() public méthode

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

Dispose() protected méthode

Releases unmanaged and - optionally - managed resources.
protected Dispose ( bool disposing ) : void
disposing bool true to release both managed and unmanaged resources; false to release only unmanaged resources.
Résultat void

FindAllContracts() public méthode

Finds a list of all Stump contracts.
public FindAllContracts ( ) : IList
Résultat IList

FindStump() public méthode

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

Shutdown() public méthode

Stops this instance of the Stumps server.
public Shutdown ( ) : void
Résultat void

Start() public méthode

Starts this instance of the Stumps server.
public Start ( ) : void
Résultat void

StumpNameExists() public méthode

Determines if a stump with the specified name exists.
public StumpNameExists ( string stumpName ) : bool
stumpName string The name of the stump.
Résultat bool

StumpsServerInstance() public méthode

Initializes a new instance of the T:Stumps.Server.StumpsServerInstance class.
public StumpsServerInstance ( IServerFactory serverFactory, string serverId, IDataAccess dataAccess ) : System
serverFactory IServerFactory The factory used to initialize new server instances.
serverId string The unique identifier of the Stumps server.
dataAccess IDataAccess The data access provider used by the instance.
Résultat System