Copyright	(c) Tim Watson 2017
License	BSD3 (see the file LICENSE)
Maintainer	Tim Watson <[email protected]>
Stability	experimental
Portability	non-portable (requires concurrency)
Safe Haskell	None
Language	Haskell2010

Control.Distributed.Process.Supervisor.Management

Contents

Mx Event Type

Description

Synopsis

supervisionAgentId :: MxAgentId
supervisionMonitor :: Process ProcessId
monitorSupervisor :: SupervisorPid -> Process (ReceivePort MxSupervisor)
unmonitorSupervisor :: SupervisorPid -> Process ()
data MxSupervisor
- = SupervisorBranchRestarted {
  - supervisorPid :: SupervisorPid
  - childSpecKey :: ChildKey
  - diedReason :: DiedReason
  - branchStrategy :: RestartStrategy
  }
- | SupervisedChildRestarting {
  - supervisorPid :: SupervisorPid
  - childInScope :: Maybe ChildPid
  - childSpecKey :: ChildKey
  - exitReason :: ExitReason
  }
- | SupervisedChildStarted {
  - supervisorPid :: SupervisorPid
  - childRef :: ChildRef
  - childSpecKey :: ChildKey
  }
- | SupervisedChildStartFailure {
  - supervisorPid :: SupervisorPid
  - startFailure :: StartFailure
  - childSpecKey :: ChildKey
  }
- | SupervisedChildDied {
  - supervisorPid :: SupervisorPid
  - childPid :: ChildPid
  - exitReason :: ExitReason
  }
- | SupervisedChildInitFailed {
  - supervisorPid :: SupervisorPid
  - childPid :: ChildPid
  - initFailure :: ChildInitFailure
  }
- | SupervisedChildStopped {
  - supervisorPid :: SupervisorPid
  - childRef :: ChildRef
  - diedReason :: DiedReason
  }
- | SupervisorShutdown {
  - supervisorPid :: SupervisorPid
  - shutdownMode :: ShutdownMode
  - exitRason :: ExitReason
  }

Documentation

supervisionAgentId :: MxAgentId Source #

The MxAgentId for the node monitoring agent.

supervisionMonitor :: Process ProcessId Source #

Starts the supervision monitoring agent.

monitorSupervisor :: SupervisorPid -> Process (ReceivePort MxSupervisor) Source #

Monitor the supervisor for the given pid. Binds a typed channel to the calling process, to which the resulting ReceivePort belongs.

Multiple monitors can be created for any calling process - sup pair. Each monitor maintains its own typed channel, which will only contain MxSupervisor entries obtained after the channel was established.

unmonitorSupervisor :: SupervisorPid -> Process () Source #

Removes all monitors for sup, associated with the calling process. It is not possible to delete individual monitors (i.e. typed channels).

Mx Event Type

data MxSupervisor Source #

Supervisor event data published to the management API

Constructors

SupervisorBranchRestarted	A branch restart took place
Fields supervisorPid :: SupervisorPid childSpecKey :: ChildKey diedReason :: DiedReason branchStrategy :: RestartStrategy
SupervisedChildRestarting	A child is being restarted
Fields supervisorPid :: SupervisorPid childInScope :: Maybe ChildPid childSpecKey :: ChildKey exitReason :: ExitReason
SupervisedChildStarted	A child has been started
Fields supervisorPid :: SupervisorPid childRef :: ChildRef childSpecKey :: ChildKey
SupervisedChildStartFailure	A child failed to start
Fields supervisorPid :: SupervisorPid startFailure :: StartFailure childSpecKey :: ChildKey
SupervisedChildDied	A child process death was detected
Fields supervisorPid :: SupervisorPid childPid :: ChildPid exitReason :: ExitReason
SupervisedChildInitFailed	A child failed during init
Fields supervisorPid :: SupervisorPid childPid :: ChildPid initFailure :: ChildInitFailure
SupervisedChildStopped	A child has been stopped
Fields supervisorPid :: SupervisorPid childRef :: ChildRef diedReason :: DiedReason
SupervisorShutdown	A supervisor is shutting down
Fields supervisorPid :: SupervisorPid shutdownMode :: ShutdownMode exitRason :: ExitReason