Skip to main content

WaitUntilContext

Struct WaitUntilContext 

Source
pub struct WaitUntilContext { /* private fields */ }
Expand description

A context for managing wait_until tasks within an application. This handles local task execution and coordinates with the runtime via gRPC.

Implementations§

Source§

impl WaitUntilContext

Source

pub fn new(application_id: Option<String>) -> WaitUntilContext

Creates a new WaitUntilContext.

Source

pub async fn from_env( application_id: Option<String>, ) -> Result<WaitUntilContext, AlienError<ErrorData>>

Creates a new WaitUntilContext and connects to gRPC endpoint from environment variables. This is the recommended way to create a WaitUntilContext in production.

Source

pub async fn from_env_with_vars( application_id: Option<String>, env_vars: &HashMap<String, String>, ) -> Result<WaitUntilContext, AlienError<ErrorData>>

Creates a new WaitUntilContext and connects to gRPC endpoint from provided environment variables.

Source

pub fn new_with_grpc_client( application_id: Option<String>, grpc_client: WaitUntilServiceClient<Channel>, ) -> WaitUntilContext

Creates a new WaitUntilContext with a gRPC client.

Source

pub fn set_grpc_client(&mut self, client: WaitUntilServiceClient<Channel>)

Sets the gRPC client for communicating with the runtime.

Source

pub fn application_id(&self) -> &str

Gets the application ID.

Source

pub async fn start_drain_listener(&self) -> Result<(), AlienError<ErrorData>>

Starts a background task that waits for drain signals from the runtime. This should be called once when the application starts.

Source§

impl WaitUntilContext

Source

pub fn wait_until<F, Fut>( &self, task_fn: F, ) -> Result<(), AlienError<ErrorData>>
where F: FnOnce() -> Fut + Send + 'static, Fut: Future<Output = ()> + Send + 'static,

Registers a new wait_until task that will be executed immediately. The task runs in the application process but is tracked by the runtime.

Trait Implementations§

Source§

impl Binding for WaitUntilContext

Source§

impl Debug for WaitUntilContext

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
Source§

impl WaitUntil for WaitUntilContext

Source§

fn wait_for_drain_signal<'life0, 'async_trait>( &'life0 self, timeout_duration: Option<Duration>, ) -> Pin<Box<dyn Future<Output = Result<DrainConfig, AlienError<ErrorData>>> + Send + 'async_trait>>
where 'life0: 'async_trait, WaitUntilContext: 'async_trait,

Waits for a drain signal from the runtime. This is a blocking call that returns when the runtime decides it’s time to drain.
Source§

fn drain_all<'life0, 'async_trait>( &'life0 self, config: DrainConfig, ) -> Pin<Box<dyn Future<Output = Result<DrainResponse, AlienError<ErrorData>>> + Send + 'async_trait>>
where 'life0: 'async_trait, WaitUntilContext: 'async_trait,

Drains all currently registered tasks. This waits for all tasks to complete or timeout.
Source§

fn get_task_count<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<u32, AlienError<ErrorData>>> + Send + 'async_trait>>
where 'life0: 'async_trait, WaitUntilContext: 'async_trait,

Gets the current number of registered tasks.
Source§

fn notify_drain_complete<'life0, 'async_trait>( &'life0 self, response: DrainResponse, ) -> Pin<Box<dyn Future<Output = Result<(), AlienError<ErrorData>>> + Send + 'async_trait>>
where 'life0: 'async_trait, WaitUntilContext: 'async_trait,

Notifies the runtime that draining is complete.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more