Skip to main content

HookEventBroadcaster

Struct HookEventBroadcaster 

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

In-process pub/sub broker for hook events. Lives on GrpcLocalService so every handler shares the same broker and a subscribe_hook_events stream and a respond_to_hook reply meet on the same correlator.

Implementations§

Source§

impl HookEventBroadcaster

Source

pub fn new() -> Self

Source

pub fn subscribe(&self) -> Receiver<ProtoHookEvent>

Subscribe a fresh stream. Each call returns its own mpsc::Receiver backed by a forwarding task that drains the underlying broadcast::Receiver. The mpsc shape lets us close the stream cleanly when the subscriber drops, and lets the Lagged error close the stream rather than panicking.

Source

pub fn emit( &self, event_name: impl Into<String>, payload_json: impl Into<String>, ) -> String

Emit a fresh hook event. Returns the hook_event_id the caller should pass to Self::await_response. The id is a stringified UUIDv4 so it survives JSON round-trips intact.

payload_json is delivered verbatim — schema validation lives in the catalog (see GetHookEventSchema) and is the caller’s responsibility for now.

Source

pub fn emit_and_wait( &self, event_name: impl Into<String>, payload_json: impl Into<String>, timeout: Duration, ) -> (String, EmitWaiter)

Register a single-shot response slot for hook_event_id and emit at the same time. Returns the id and a future that resolves to the hook’s reply (or times out).

Use this from the capture/merge code paths when you both want to fire the event and wait for the reply atomically.

Source

pub async fn await_response( &self, hook_event_id: &str, timeout: Duration, ) -> Option<HookResponse>

Await a reply for hook_event_id with a deadline. Returns None when the deadline elapses before a hook responds (the emit caller’s “no hook acted on this in time” branch).

The slot must have been reserved via Self::emit_and_wait — calling this for a never-registered id resolves to None immediately.

Source

pub fn deliver_response( &self, hook_event_id: &str, response: HookResponse, ) -> bool

Deliver a hook reply to the in-flight emit waiting on hook_event_id. Called by the RespondToHook handler. Returns true when the reply was delivered (a waiter was present); false when no waiter is registered (timed out, or already replied).

Trait Implementations§

Source§

impl Clone for HookEventBroadcaster

Source§

fn clone(&self) -> HookEventBroadcaster

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Default for HookEventBroadcaster

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
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: 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: 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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