C# Class PlaygroundKeeper.Playground

Show file Open project: Starcounter/PlaygroundKeeper Class Usage Examples

Public Properties

Property Type Description
Created System.DateTime
DatabaseName string
HostName string
Owner Simplified.Ring3.SystemUser
PlaygroundHost PlaygroundHost
Updated System.DateTime
UserHttpPort ushort

Public Methods

Method Description
AddReverseProxy ( System.Action completionCallback = null, Action errorCallback = null ) : void

Add reverse proxy

AddUriAlias ( System.Action completionCallback = null, Action errorCallback = null ) : void

Add uri alias

AllocatedPortnumber ( System.Action completionCallback = null, Action errorCallback = null ) : void

Allocate and set port number

CreateDatabase ( System.Action completionCallback = null, Action errorCallback = null ) : void

Create database

DeleteDatabase ( System.Action completionCallback = null, Action errorCallback = null ) : void

Delete database

InstallSoftware ( string depotKey, string appId, System.Action completionCallback = null, Action errorCallback = null ) : void

Install software

RegisterHooks ( ) : void

Register database hooks

RemoveReverseProxy ( System.Action completionCallback = null, Action errorCallback = null ) : void

Remove reverse proxy

RemoveUriAlias ( System.Action completionCallback = null, Action errorCallback = null ) : void

Remove uri alias

StartAllApplications ( System.Action completionCallback = null, Action errorCallback = null ) : void

Start all applications in a hive (auto-started apps)

StartDatabase ( System.Action completionCallback = null, Action errorCallback = null ) : void

Start database

UnInstallSoftware ( string depotKey, string appId, System.Action completionCallback = null, Action errorCallback = null ) : void

Uninstall software

Not implmented

Private Methods

Method Description
InstallApplicationsLoop ( ConcurrentStack softwareVersionsToInstall, System.Action completionCallback = null, Action errorCallback = null ) : void

TODO: Make thread safe

Method Details

AddReverseProxy() public method

Add reverse proxy
public AddReverseProxy ( System.Action completionCallback = null, Action errorCallback = null ) : void
completionCallback System.Action
errorCallback Action
return void

AddUriAlias() public method

Add uri alias
public AddUriAlias ( System.Action completionCallback = null, Action errorCallback = null ) : void
completionCallback System.Action
errorCallback Action
return void

AllocatedPortnumber() public method

Allocate and set port number
public AllocatedPortnumber ( System.Action completionCallback = null, Action errorCallback = null ) : void
completionCallback System.Action
errorCallback Action
return void

CreateDatabase() public method

Create database
public CreateDatabase ( System.Action completionCallback = null, Action errorCallback = null ) : void
completionCallback System.Action
errorCallback Action
return void

DeleteDatabase() public method

Delete database
public DeleteDatabase ( System.Action completionCallback = null, Action errorCallback = null ) : void
completionCallback System.Action
errorCallback Action
return void

InstallSoftware() public method

Install software
public InstallSoftware ( string depotKey, string appId, System.Action completionCallback = null, Action errorCallback = null ) : void
depotKey string
appId string
completionCallback System.Action
errorCallback Action
return void

RegisterHooks() public static method

Register database hooks
public static RegisterHooks ( ) : void
return void

RemoveReverseProxy() public method

Remove reverse proxy
public RemoveReverseProxy ( System.Action completionCallback = null, Action errorCallback = null ) : void
completionCallback System.Action
errorCallback Action
return void

RemoveUriAlias() public method

Remove uri alias
public RemoveUriAlias ( System.Action completionCallback = null, Action errorCallback = null ) : void
completionCallback System.Action
errorCallback Action
return void

StartAllApplications() public method

Start all applications in a hive (auto-started apps)
public StartAllApplications ( System.Action completionCallback = null, Action errorCallback = null ) : void
completionCallback System.Action
errorCallback Action
return void

StartDatabase() public method

Start database
public StartDatabase ( System.Action completionCallback = null, Action errorCallback = null ) : void
completionCallback System.Action
errorCallback Action
return void

UnInstallSoftware() public method

Uninstall software
Not implmented
public UnInstallSoftware ( string depotKey, string appId, System.Action completionCallback = null, Action errorCallback = null ) : void
depotKey string
appId string
completionCallback System.Action
errorCallback Action
return void

Property Details

Created public property

public DateTime,System Created
return System.DateTime

DatabaseName public property

Database name, "party-854"
public string DatabaseName
return string

HostName public property

Hostname, "party-854.mysampleapp.com"
public string HostName
return string

Owner public property

Playground owner/creator, null if anonymous
public SystemUser,Simplified.Ring3 Owner
return Simplified.Ring3.SystemUser

PlaygroundHost public property

Host machine
public PlaygroundHost,PlaygroundKeeper PlaygroundHost
return PlaygroundHost

Updated public property

public DateTime,System Updated
return System.DateTime

UserHttpPort public property

Database port, 7000 (see port range on the playground host)
public ushort UserHttpPort
return ushort