Managed.Agent

Documentation

fromList :: [(ProbeID, Probe e)] -> Agent e

fromList specialized to Agent

toList :: Agent e -> [(ProbeID, Probe e)]

toList specialized to Agent

(!) :: Agent e -> ProbeID -> Probe e infixl 9

! specialized to Agent

(!?) :: Agent e -> ProbeID -> Maybe (Probe e) infixl 9

!? specialized to Agent

invoke

Arguments

:: NFData (Out e)

=> Agent e

Agent that contains the probe to be called

-> ProbeID

ID of the probe to be called

-> [In e]

Input parameters

-> IO (Either AgentException (Out e))

Invokes (calls) a Probe.

This function never throws an exception, instead, an Either is used. Any errors and exceptions caused by incorrect ProbeID, incorrect input parameters, or by the probe call itself are caught and passed as an AgentException.

The result is fully evaluated using force before it's returned (to keep all exceptions inside the Either).

ids :: Agent e -> [ProbeID]

List all Probe IDs

invokeUnsafe :: NFData (Out e) => Agent e -> ProbeID -> [In e] -> IO (Out e)

An unsafe variant of invoke.

This function rethrows all exceptions and errors caused by probe lookup or input parameters. Exceptions caused by probe invocation are rethrown as ProbeRuntimeException.

describe :: Agent e -> ProbeID -> Maybe ProbeDescription

Create a full description of a Probe

describeEither :: Agent e -> ProbeID -> Either AgentException ProbeDescription

A variant of describe that returns Either instead of Maybe

describeHuman :: Agent e -> ProbeID -> Maybe String

Create a human-readable description of a probe