Structs§
- Application
Config - Configuration values for an application.
- Argument
Error - Occurs when an argument to a function was incorrect or not valid at the given time.
- Child
Spec - The child specification describes how the supervisor starts, shuts down, and restarts child processes.
- From
- Information about a GenServer call request.
- GenServer
Options - Options used to configure a GenServer.
- Hash
Ring - A concurrent, consistent hash ring.
- Local
- Represents a local object in the current process userspace.
- NoPermits
- Error when there are no permits available.
- Node
Options - Options used to configure this node as a distributed node.
- Owned
Semaphore - 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.
- Owned
Semaphore Permit - Represents an owned permit to a OwnedSemaphore.
- Process
- A light weight task that can send and receive messages.
- Process
Flags - A collection of configurable flags for a process.
- Process
Info - Debug information for a specific process.
- Process
Receiver - Used to receive messages from processes.
- Registry
- Provides a centralized ‘registry’ of processes using any value as a key.
- Registry
Options - 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.
- Semaphore
Permit - 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.
- Supervisor
Child Info - Information about a child of a Supervisor.
- Supervisor
Counts - Contains the counts of all of the supervised children.
- Supervisor
Options - Options used to configure a Supervisor.
- Task
- A task is a lightweight thread of execution designed to run one particular action.
- Task
Error - An error occured while executing the task.
- Task
Handle - 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§
- Auto
Shutdown - Defines how a superviser should handle shutdown when a significant process exits.
- Call
Error - Occurs when a server call fails.
- Child
Type - The type of child process.
- Dest
- A process destination.
- Dests
- One or more process destinations.
- Exit
Reason - Represents the reason a process exits.
- Message
- A messages sent to a process.
- Node
- Represents a local or remote node of processes.
- Node
State - 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.
- Registry
Error - Errors for Registry calls.
- Registry
Key - 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.
- Supervision
Strategy - The supervision strategy to use for each child.
- Supervisor
Error - Errors for Supervisor calls.
- System
Message - 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.