Module overclock::core

Overclock core functionality

Structs

• AbortHandle
  AbortHandle used to abort Abortable
• AbortRegistration
  Sync AbortRegistration, should only be used within the actor lifecycle.
• Abortable
  A future/stream which can be remotely short-circuited using an AbortHandle.
• AbortableBoundedChannel
  Abortable tokio bounded mpsc channel implementation
• AbortableBoundedHandle
  Abortable bounded handle
• AbortableBoundedInbox
  Abortable bounded inbox.
• AbortableUnboundedChannel
  Abortable tokio unbounded mpsc channel implementation
• AbortableUnboundedHandle
  Abortable unbounded handle
• AbortableUnboundedInbox
  Abortable unbounded inbox, it returns None if the actor/channel got aborted
• ActorError
  An actor’s error which contains an optional request for the supervisor
• BoundedChannel
  A tokio bounded mpsc channel implementation
• BoundedHandle
  Bounded handle
• BoundedInbox
  Bounded inbox
• CleanupData
  Cleanup self data struct
• Data
  Data for given T: resource, along with subscribers
• InitializedRx
  InitializedRx signal receiver
• IntervalChannel
  A tokio IntervalStream channel implementation, which emit Instants
• IntervalHandle
  Interval channel’s handle, can be used to abort the interval channel
• IoChannel
  IoChannel(Stream/AsyncRead/AsyncWrite/fut) wrapper
• IoHandle
  IoChannel’s handle
• LocateScopeId
  Helper struct, to traverse the supervision tree and locate the scope id
• Marker
  Marker struct useful to propagate bounds through the Supervisor generic
• NullChannel
  Null channel
• NullHandle
  Null handle, note: invoking abort will abort the manually defined abortable future/streams in the actor’s run lifecycle (if any)
• NullInbox
  Null Inbox
• NullSupervisor
  Null supervisor, with no-ops
• OVERCLOCK_PARTITIONS
  Overclock partition count, default is the thread count
• PROMETHEUS_REGISTRY
  PROMETHEUS REGISTRY, used by overclock to register metrics
• Rt
  The actor’s local context
• Runtime
  Overclock runtime, spawn the root actor, and server (if enabled)
• SCOPES
  Array of Partitioned Scopes
• SCOPE_ID_RANGE
  The allowed scope_id range
• Scope
  The Actor’s Scope, acts as global context for the actor.
• Service
  An actor’s service metrics
• ServiceScopesIterator
  The microservices scopes ids iterator
• TcpListener
  A TCP socket server, listening for connections.
• TcpListenerHandle
  Tcp listener handle, for tokio TcpListenerStream channel
• TcpListenerStream
  A wrapper around TcpListener that implements Stream.
• UnboundedChannel
  A tokio unbounded mpsc channel implementation
• UnboundedHandle
  Unbounded handle
• UnboundedInbox
  Unbounded inbox of unbounded channel
• VISIBLE_DATA
  Visible global resources, todo add the dir name

Enums

• ActorRequest
  Actor shutdown error reason.
• Event
  Pushed event for a dynamic resources
• ServiceStatus
  The possible statuses a service (application) can be
• Subscriber
  Subscriber variants

Traits

• Actor
  The all-important Actor trait. This defines an Actor and what it do.
• ActorResultExt
  ActorResult extension trait
• Channel
  Defines a channel which becomes a sender and receiver half
• ChannelBuilder
  Channel builder trait, to be implemented on the actor type
• CleanupFromOther
  Cleanup/unsubscribe from other
• CleanupSelf
  Cleanup resource from self scope
• Deserialize
  A data structure that can be deserialized from any data format supported by Serde.
• Resource
  Resource blanket trait, forces Clone + Send + Sync + ’static bounds on any resource
• Route
  Dynamic route as trait object, should be implemented on the actor’s handle
• Serialize
  A data structure that can be serialized into any data format supported by Serde.
• ServiceEvent
  Ideally it should be implemented using proc_macro on the event type
• Shutdown
  Shutdown contract , should be implemented on the handle
• ShutdownEvent
  Defines the Shutdown event variant
• StreamExt
  An extension trait for Streams that provides a variety of convenient combinator functions.
• SupHandle
  The sup handle which supervise T: Actor

Type Definitions

• ActorResult
  The returned result by the actor
• Depth
  The actor level position in the supervision tree
• PartitionedScopes
  Partitioned Scopes RwLock hashmap
• ResourceRef
  Unique Identifier for the resource, provided by the subscriber.
• ScopeId
  The actor’s unique scope id

Derive Macros

• Deserialize
• Serialize