Crate hydra

Crate hydra 

Source

Structs§

ApplicationConfig
Configuration values for an application.
ArgumentError
Occurs when an argument to a function was incorrect or not valid at the given time.
ChildSpec
The child specification describes how the supervisor starts, shuts down, and restarts child processes.
From
Information about a GenServer call request.
GenServerOptions
Options used to configure a GenServer.
HashRing
A concurrent, consistent hash ring.
Local
Represents a local object in the current process userspace.
NoPermits
Error when there are no permits available.
NodeOptions
Options used to configure this node as a distributed node.
OwnedSemaphore
An owned semaphore is identical to a Semaphore except it can be owned by an actor and it’s permits can still be shared externally.
OwnedSemaphorePermit
Represents an owned permit to a OwnedSemaphore.
Process
A light weight task that can send and receive messages.
ProcessFlags
A collection of configurable flags for a process.
ProcessInfo
Debug information for a specific process.
ProcessReceiver
Used to receive messages from processes.
Registry
Provides a centralized ‘registry’ of processes using any value as a key.
RegistryOptions
Options used to configure a Registry.
Semaphore
A semaphore maintains a set of permits. Permits are used to synchronize access to a shared resource. A semaphore differs from a mutex in that it can allow more than one concurrent caller to access the shared resource at a time.
SemaphorePermit
Represents a permit to a Semaphore.
Supervisor
A supervisor is a process which supervises other processes, which we refer to as child processes. Supervisors are used to build a hierarchical process structure called a supervision tree. Supervision trees provide fault-tolerance and encapsulate how our applications start and shutdown.
SupervisorChildInfo
Information about a child of a Supervisor.
SupervisorCounts
Contains the counts of all of the supervised children.
SupervisorOptions
Options used to configure a Supervisor.
Task
A task is a lightweight thread of execution designed to run one particular action.
TaskError
An error occured while executing the task.
TaskHandle
The result of a spawned task, can be used to await the task result, or shutdown the task.
Timeout
Occurs when an operation has timed out.

Enums§

AutoShutdown
Defines how a superviser should handle shutdown when a significant process exits.
CallError
Occurs when a server call fails.
ChildType
The type of child process.
Dest
A process destination.
Dests
One or more process destinations.
ExitReason
Represents the reason a process exits.
Message
A messages sent to a process.
Node
Represents a local or remote node of processes.
NodeState
The different states a node can be in.
Pid
A unique identifier of a process in hydra.
Reference
A unique id that pertains to a specific node.
RegistryError
Errors for Registry calls.
RegistryKey
A registry key.
Restart
Controls what a supervisor should consider to be a successful termination or not.
Shutdown
Defines how a child process should be terminated.
SupervisionStrategy
The supervision strategy to use for each child.
SupervisorError
Errors for Supervisor calls.
SystemMessage
A message sent from the hydra system.

Traits§

Application
Main application logic and entry point for a hydra program.
GenServer
A trait for implementing the server of a client-server relation.
Receivable
An object that can be sent or received to/from a process.

Attribute Macros§

main
Marks an async function to be executed as a hydra application.
test
Marks an async function to be executed as a hydra application suitable for the test environment.