Documentation
¶
Overview ¶
Package service provides platform-agnostic service management actions.
Index ¶
- type Provider
- func (p *Provider) CompensateDisable(state Tombstone) error
- func (p *Provider) CompensateEnable(state Tombstone) error
- func (p *Provider) CompensateRestart(_ Tombstone) error
- func (p *Provider) CompensateStart(state Tombstone) error
- func (p *Provider) CompensateStop(state Tombstone) error
- func (p *Provider) Disable(name Resource) (Resource, Tombstone, error)
- func (p *Provider) Enable(name Resource) (Resource, Tombstone, error)
- func (p *Provider) Enabled(name Resource) (bool, error)
- func (p *Provider) Exists(name Resource) (bool, error)
- func (p *Provider) Restart(name Resource) (Resource, Tombstone, error)
- func (p *Provider) Running(name Resource) (bool, error)
- func (p *Provider) Start(name Resource) (Resource, Tombstone, error)
- func (p *Provider) Stop(name Resource) (Resource, Tombstone, error)
- type Resource
- type Tombstone
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Provider ¶
type Provider struct {
op.ProviderBase
}
Provider provides platform-agnostic service management. Platform-specific behavior is delegated to p.Context().Platform.ServiceManager.
+devlore:access=planned
func (*Provider) CompensateDisable ¶
CompensateDisable undoes a Disable by enabling the service if it was enabled before.
func (*Provider) CompensateEnable ¶
CompensateEnable undoes an Enable by disabling the service if it wasn't enabled before.
func (*Provider) CompensateRestart ¶
CompensateRestart is a no-op. A restarted service was already running.
func (*Provider) CompensateStart ¶
CompensateStart undoes a Start by stopping the service if it wasn't running before.
func (*Provider) CompensateStop ¶
CompensateStop undoes a Stop by starting the service if it was running before.
func (*Provider) Disable ¶
Disable disables a service from starting at boot.
Parameters:
- name: service resource identifying the service
func (*Provider) Enable ¶
Enable enables a service to start at boot.
Parameters:
- name: service resource identifying the service
func (*Provider) Enabled ¶
Enabled returns true if the named service is enabled to start at boot.
Parameters:
- name: service resource to check
func (*Provider) Exists ¶
Exists returns true if the named service exists on the system.
Parameters:
- name: service resource to check
func (*Provider) Restart ¶
Restart restarts a service. Compensation is a no-op — if the service was restarted, it was already running.
Parameters:
- name: service resource identifying the service
func (*Provider) Running ¶
Running returns true if the named service is currently running.
Parameters:
- name: service resource to check
type Resource ¶
type Resource struct {
op.ResourceBase
Name string
}
Resource represents a system service.
func ResourceFromValue ¶
ResourceFromValue constructs a service.Resource from a string service name.
Parameters:
- v: expected to be a string service name
Returns:
- Resource: initialized with the given name
- error: if v is not a string
Source Files