Skip to main content

RpcAgent

Struct RpcAgent 

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

RPC agent that manages function registration and remote invocation.

Each rank creates an RpcAgent wrapping a Backend. Functions are registered with [register] and invoked remotely with [rpc_sync].

§Response correlation

Concurrent rpc_sync calls are correlated by request_id. If a received response has a different request_id than expected, it is buffered and the agent retries the recv. Buffered responses are checked before issuing new recv calls.

Implementations§

Source§

impl RpcAgent

Source

pub fn new(backend: Arc<dyn Backend>) -> Self

Create a new RPC agent.

Source

pub fn register<F>(&self, name: &str, handler: F)
where F: Fn(&[u8]) -> Result<Vec<u8>, String> + Send + Sync + 'static,

Register a callable function.

The handler receives serialized arguments and must return serialized results. If the registry lock is poisoned, this recovers the inner data and continues.

Source

pub fn rpc_sync( &self, dst_rank: usize, function_name: &str, args: &[u8], ) -> FerrotorchResult<Vec<u8>>

Invoke a function on a remote rank synchronously.

Sends the request, then waits for a response with the matching request_id. If a response for a different request is received, it is buffered for later retrieval.

§Errors

Returns an error if the remote function is not found, if the remote handler returns an error, or if communication fails.

Source

pub fn rpc_async( self: &Arc<Self>, dst_rank: usize, function_name: &str, args: &[u8], ) -> JoinHandle<FerrotorchResult<Vec<u8>>>

Invoke a function on a remote rank asynchronously.

Spawns a thread to perform the RPC call. Returns a join handle that can be used to retrieve the result.

§Limitations

Spawns an unbounded number of OS threads. Each call to rpc_async creates a new thread. This is acceptable for infrequent coordination RPCs but is not suitable for high-frequency patterns. A thread pool or async runtime would be needed for that use case.

Source

pub fn handle_request( &self, src_rank: usize, request_data: &[u8], ) -> FerrotorchResult<()>

Handle an incoming RPC request: look up the function, call it, and send the response back.

Source

pub fn rank(&self) -> usize

The rank of this agent.

Source

pub fn world_size(&self) -> usize

The world size.

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> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

Source§

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

Source§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

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> 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, 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
Source§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,