C# Class Stumps.Server.StumpsServerInstance

A class that represents an the environment and configuration of a Stumps server.
Inheritance: IDisposable
显示文件 Open project: Cayan-LLC/stumps Class Usage Examples

Public Methods

Method 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.

Protected Methods

Method Description
Dispose ( bool disposing ) : void

Releases unmanaged and - optionally - managed resources.

Private Methods

Method 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 method

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.
return StumpContract

DeleteStump() public method

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

Dispose() public method

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

Dispose() protected method

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.
return void

FindAllContracts() public method

Finds a list of all Stump contracts.
public FindAllContracts ( ) : IList
return IList

FindStump() public method

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.
return StumpContract

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

StumpNameExists() public method

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

StumpsServerInstance() public method

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.
return System