Struct RemoteAddress 

pub struct RemoteAddress { /* private fields */ }

A type which is used to send messages to a remote actor.

Sender trait is implemented for this type, so it can be converted into a Recipient type easily. This will allow us to store a remote address in the same place as a locals address, and send messages with it without caring about the underlying transport details.

NOTE: user should not send a received RemoteAddress to another remote actor, it is considered as a meaningless operation.

Implementations

impl RemoteAddress

pub const REMOTE_FLAG: u64

High bit of the 64-bit id space, reserved to tag a SenderId::index value as remote address.

pub fn new( remote_actor_id: u64, session: Address<Session>, registry: RemoteActorRegistry, ) -> Self

Constructs a new RemoteAddress with the specified remote actor index and the address of the IPC connection session actor. The registry is used to construct the encode context for this address.

The index is computed by reversing the bits of session.index() into bits 0..62 (small session ids occupy the high bits, growing downward) and XORing with remote_actor_id (small ids occupy the low bits, growing upward). Bit 63 is reserved for REMOTE_FLAG.

The collision of the index is structurally possible but extremely unlikely in practice since it requires remote_actor_id * session.index() > 2^63.

pub fn closed(&self) -> impl Future<Output = ()> + Send

Completes when the session has been closed.

pub fn is_closed(&self) -> bool

Checks if the session has been closed.

pub fn capacity(&self) -> usize

Returns the capacity of the session.

Trait Implementations

impl Clone for RemoteAddress

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RemoteAddress

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

Formats the value using the given formatter.

impl Decode for RemoteAddress

fn decode(buf: Bytes, ctx: Option<&DecodeContext>) -> Result<Self, DecodeError>

Decodes the remote message from the provided buffer.

const ID: u64 = 0

Message identifier. A remote message should have an unique identifier so the Handler<RemoteMessage> can dispatch the message to the proper handler.

impl<M> From<RemoteAddress> for Recipient<M>

where M: Message + Encode, M::Result: Decode,

fn from(address: RemoteAddress) -> Self

Converts to this type from the input type.

impl Hash for RemoteAddress

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for RemoteAddress

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<M> Sender<M> for RemoteAddress

where M: Message + Encode, M::Result: Decode,

fn closed(&self) -> ClosedResultFuture<'_>

Completes when the receiver has been closed.

fn is_closed(&self) -> bool

Checks if the channel has been closed.

fn capacity(&self) -> usize

Returns the current capacity of the channel.

fn send(&self, msg: M) -> SendResultFuture<'_, M>

Sends a message, waiting until there is capacity, and returns a Receiver which can be used to receive the message response.

fn do_send(&self, msg: M) -> DoSendResultFuture<'_, M>

Sends a message, waiting until there is capacity, without expecting a response.

fn try_send(&self, msg: M) -> SendResult<M>

Attempts to immediately send a message and returns a Receiver which can be used to receive the message response.

fn try_do_send(&self, msg: M) -> DoSendResult<M>

Attempts to immediately send a message without expecting a response.

fn send_timeout(&self, msg: M, timeout: Duration) -> SendResultFuture<'_, M>

Sends a message, waiting until there is capacity, but only for a limited time, and returns a Receiver which can be used to receive the message response.

fn do_send_timeout( &self, msg: M, timeout: Duration, ) -> DoSendResultFuture<'_, M>

Sends a message, waiting until there is capacity, but only for a limited time, without expecting a response.

fn blocking_send(&self, msg: M) -> SendResult<M>

Blocking send to call outside of asynchronous contexts.

fn blocking_do_send(&self, msg: M) -> DoSendResult<M>

Blocking do_send to call outside of asynchronous contexts.

fn type_erased_recipient(&self) -> Option<TypeErasedRecipient>

Available on crate feature type-erased-recipient-hook only.

Returns a type-erased trait object which can be downcast into a concrete Recipient<M>, where M is a specific message type chosen by the user who overrides the Actor::type_erased_recipient_fn method.

impl SenderId for RemoteAddress

fn index(&self) -> u64

Returns the index of the sender.

fn is_remote(&self) -> bool

Available on crate feature ipc only.

Returns true if this sender refers to an actor in another process.

impl Eq for RemoteAddress