daemon

Documentation

Overview

Package daemon provides facilities for daemon operation.

Index

• Constants
• Variables
• func EndpointPath() (string, error)
• func Register() error
• func RegisteredStart() (bool, error)
• func RegisteredStop() (bool, error)
• func Unregister() error
• type Lock
  • func AcquireLock() (*Lock, error)
  • func (l *Lock) Release() error

Constants

const RegistrationSupported = false

RegistrationSupported indicates whether or not daemon registration is supported on this platform.

Variables

var AutostartDisabled bool

AutostartDisabled controls whether or not daemon autostart is disabled for Mutagen. It is set automatically based on the MUTAGEN_DISABLE_AUTOSTART environment variable.

Functions

func EndpointPath

func EndpointPath() (string, error)

EndpointPath computes the path to the daemon IPC endpoint, creating any intermediate directories as necessary.

func Register

func Register() error

Register performs automatic daemon startup registration.

func RegisteredStart

func RegisteredStart() (bool, error)

RegisteredStart potentially handles daemon start operations if the daemon is registered for automatic start with the system. It returns false if the start operation was not handled and should be handled by the normal start command.

func RegisteredStop

func RegisteredStop() (bool, error)

RegisteredStop potentially handles stop start operations if the daemon is registered for automatic start with the system. It returns false if the stop operation was not handled and should be handled by the normal stop command.

func Unregister

func Unregister() error

Unregister performs automatic daemon startup de-registration.

Types

type Lock

type Lock struct {
	// contains filtered or unexported fields
}

Lock represents the global daemon lock. It is held by a single daemon instance at a time.

func AcquireLock

func AcquireLock() (*Lock, error)

AcquireLock attempts to acquire the global daemon lock.

func (*Lock) Release

func (l *Lock) Release() error

Release releases the daemon lock.