ITopshelfManager Interface

Summary

Provides a high level utility for managing Topshelf services
Assembly
Cake.Topshelf.dll
Namespace
Cake.Topshelf
Implementing Types
graph BT Type["ITopshelfManager"] class Type type-node Implementing0["TopshelfManager"]-.->Type click Implementing0 "/api/Cake.Topshelf/TopshelfManager"

Syntax

public interface ITopshelfManager

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<ITopshelfManager>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<ITopshelfManager>(ITopshelfManager[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<ITopshelfManager>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<ITopshelfManager>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<ITopshelfManager>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<ITopshelfManager>(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