Struct BroadcastSignalRequest 

pub struct BroadcastSignalRequest<T: BroadcastSignalRequestState> { /* private fields */ }

Request to broadcast a signal across the cluster

A signal can trigger multiple catching signal events in different process instances. Signal events are matched by name and tenant ID if multi-tenancy is enabled.

Examples

client
    .broadcast_signal()
    .with_signal_name(String::from("Hello_Signal"))
    .send()
    .await?;

Implementations

impl BroadcastSignalRequest<Initial>

pub fn with_signal_name( self, signal_name: String, ) -> BroadcastSignalRequest<WithName>

Sets the name of the signal to broadcast

Arguments

• signal_name - Name that will be matched with signal catch events

Returns

A BroadcastSignalRequest in the WithName state

impl BroadcastSignalRequest<WithName>

pub fn with_variables<T: Serialize>(self, data: T) -> Result<Self, ClientError>

Sets variables that will be available to all triggered signal events

Arguments

• data - Variables as serializable type that will be converted to JSON

Returns

A Result containing the updated BroadcastSignalRequest or a ClientError

Notes

Must be a JSON object, e.g. { "a": 1, "b": 2 }. Arrays like [1, 2] are not valid.

pub fn with_tenant_id(self, tenant_id: String) -> Self

Sets the tenant ID that owns this signal

Arguments

• tenant_id - ID of tenant that owns the signal

Returns

The updated BroadcastSignalRequest

pub async fn send(self) -> Result<BroadcastSignalResponse, ClientError>

Sends the broadcast signal request to the gateway

Returns

A Result containing the BroadcastSignalResponse or a ClientError

Errors

• INVALID_ARGUMENT: Missing signal name or invalid variables format
• PERMISSION_DENIED: Not authorized for tenant

Trait Implementations

impl<T: Clone + BroadcastSignalRequestState> Clone for BroadcastSignalRequest<T>

fn clone(&self) -> BroadcastSignalRequest<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + BroadcastSignalRequestState> Debug for BroadcastSignalRequest<T>

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

Formats the value using the given formatter.