TopshelfManager Class

Summary

Provides a high level utility for managing Topshelf services
Assembly
Cake.Topshelf.dll
Namespace
Cake.Topshelf
Interfaces
Base Types
  • Object
graph BT Type-->Base0["Object"] Type-.->Interface0["ITopshelfManager"] click Interface0 "/api/Cake.Topshelf/ITopshelfManager" Type["TopshelfManager"] class Type type-node

Syntax

public class TopshelfManager : ITopshelfManager

Constructors

Name Summary
TopshelfManager(ICakeEnvironment, IProcessRunner, ICakeLog) Initializes a new instance of the TopshelfManager class.

Methods

Name Value Summary
InstallService(FilePath, TopshelfSettings) void
Installs a Topshelf windows service
StartService(FilePath, string, int) void
Starts a Topshelf windows service
StopService(FilePath, string, int) void
Stops a Topshelf windows service
UninstallService(FilePath, string, bool, int) void
Uninstalls a Topshelf windows service

Extension Methods

Name Value Summary
Dump<TopshelfManager>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<TopshelfManager>(TopshelfManager[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<TopshelfManager>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<TopshelfManager>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
ThrowIfNull<TopshelfManager>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<TopshelfManager>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin