Skip to main content

RemoteChannelHandle

Struct RemoteChannelHandle 

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

Channel handle that communicates through SDK-internal wire protocol transport.

The handle inherits whatever transport its RemoteConfig carries. A config straight out of RemoteConfig::new has never been connected, so every operation on a handle built from it refuses with SdkError::NotConnected rather than reporting a success that reached no wire. Connect the config first.

Implementations§

Source§

impl RemoteChannelHandle

Source

pub fn negotiated_version(&self) -> Option<ProtocolVersion>

The protocol version the server selected in the current connection’s ConnectAck, or None before a handshake has completed (including on the in-process protocol transport, which never opens a connection).

Source§

impl RemoteChannelHandle

Source

pub fn new(config: &RemoteConfig) -> Result<Self, SdkError>

Creates a remote channel handle from validated configuration.

§Errors

Returns SdkError if the connection pool cannot be created.

Source

pub fn connection_state(&self) -> ConnectionState

Returns current lifecycle state from the SDK-003 state machine.

Source

pub fn reconnect_started(&self) -> Result<(), SdkError>

Records that an externally authorized real reconnect attempt started.

§Errors

Returns SdkError when the lifecycle rejects the transition.

Source

pub fn connected(&self) -> Result<Vec<ResumeRequest>, SdkError>

Marks the remote channel connected and builds subscription resume requests.

§Errors

Returns SdkError if lifecycle transition or recovery state is invalid.

Source

pub fn track_subscription(&self) -> Result<SubscriptionId, SdkError>

Marks a subscription active and assigns it to the configured pool.

§Errors

Returns SdkError if a subscription id overflows or pool assignment fails.

Source

pub fn acknowledge( &self, subscription_id: SubscriptionId, sequence: u64, ) -> Result<(), SdkError>

Records an acknowledged sequence for subscription recovery.

§Errors

Returns SdkError if the subscription is not active in the pool.

Source

pub const fn server_address(&self) -> &ServerAddress

Returns remote server address used by this handle.

Source§

impl RemoteChannelHandle

Source

pub fn publish_with_idempotency_key<M>( &self, message: &M, idempotency_key: &str, ) -> Result<DeliveryAck, SdkError>

Publishes a message with an idempotency key and returns a genuine delivery ack.

The idempotency key drives dedup-on-delivery on the server: a re-publish of the same key is delivered to subscribers at most once. The returned DeliveryAck reports whether this publish was genuinely accepted by a subscriber (DeliveryAck::is_accepted), which a caller such as the aion outbox uses to treat the send as done only on real acceptance. This is distinct from the backpressure-only publish.

§Errors

Returns SdkError when the message cannot be serialized, the round trip fails, or the transport cannot produce a genuine delivery ack.

Only with std: without it no transport could carry the key, so no keyed publish is offered rather than one that drops the key (Hermes 7 Oct 08:32).

Source

pub fn reply_to<M>( &self, request: Option<DeliveredId>, message: &M, ) -> Result<DeliveryAck, SdkError>

Publishes message as the reply to request and returns a genuine delivery ack (Fable 4c).

request is the id a delivered message carried (DeliveredMessage::message): the reply names it as its causal parent, <boot>:<id>, so the server’s tap can pair the two and measure the dwell between them. A request that carried no id (a server before protocol 1.2, or a durable message replayed from the store) gives a reply with no parent, never an invented one.

§Errors

Returns SdkError when the message cannot be serialized, the round trip fails, or the transport cannot produce a genuine delivery ack.

Trait Implementations§

Source§

impl ChannelHandle for RemoteChannelHandle

Source§

fn subscribe<M>(&self) -> Self::Subscription<M>

REFUSES. Typed subscription delivery is not implemented on this handle.

The returned stream yields exactly one item — Err(SdkError::Unwired) — and then ends. It does not touch the transport, so no Subscribe is left outstanding on the server for a stream that could never deliver.

What this replaces was worse than unimplemented. The old body performed the real wire Subscribe, registered a subscription in the pool, and then returned SdkSubscription::empty() — a stream whose poll_next is Ready(None) immediately and forever. A caller’s while let Some(m) = sub.next().await exited on the first poll while the server pumped Deliver frames at a connection nothing was reading.

For real delivery use the lower-level surface that works today: SubscriptionStream::open plus SubscriptionStream::recv_timeout (or WebSocketSubscriptionStream::open on the WebSocket transport).

Source§

type Subscription<M> = SdkSubscription<M> where M: DeserializeOwned

Stream returned by subscribe for message type M.
Source§

type ReplyFuture<'a, Resp> = ReadyResult<Resp> where Self: 'a, Resp: DeserializeOwned + 'a

Future returned by request_reply for reply type Resp.
Source§

fn publish<M>(&self, message: M) -> Result<PressureResponse, SdkError>

Publishes a typed message to the channel. Read more
Source§

fn request_reply<Req, Resp>(&self, request: Req) -> ReadyResult<Resp> ⓘ

Sends a typed request and resolves with a typed reply. Read more
Source§

impl Clone for RemoteChannelHandle

Source§

fn clone(&self) -> Self

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 Debug for RemoteChannelHandle

Source§

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

Formats the value using the given formatter. 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> 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> 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

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

fn try_from(value: U) -> Result<T, !>

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<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