Struct KernelHandle 

pub struct KernelHandle {
    id: KernelId,
    inner: Arc<dyn KernelHandleInner>,
}

Handle to a launched kernel.

Provides an ergonomic API for interacting with a kernel.

Fields

id: KernelId

inner: Arc<dyn KernelHandleInner>

Implementations

impl KernelHandle

pub fn new(id: KernelId, inner: Arc<dyn KernelHandleInner>) -> KernelHandle

Create a new kernel handle.

pub fn id(&self) -> &KernelId

Get the kernel ID.

pub async fn activate(&self) -> Result<(), RingKernelError>

Activate the kernel.

pub async fn deactivate(&self) -> Result<(), RingKernelError>

Deactivate the kernel.

pub async fn terminate(&self) -> Result<(), RingKernelError>

Terminate the kernel.

pub async fn send<M>(&self, message: M) -> Result<(), RingKernelError>

where M: RingMessage,

Send a message to the kernel.

pub async fn send_envelope( &self, envelope: MessageEnvelope, ) -> Result<(), RingKernelError>

Send a raw envelope.

pub async fn receive(&self) -> Result<MessageEnvelope, RingKernelError>

Receive a message from the kernel.

pub async fn receive_timeout( &self, timeout: Duration, ) -> Result<MessageEnvelope, RingKernelError>

Receive a message with timeout.

pub fn try_receive(&self) -> Result<MessageEnvelope, RingKernelError>

Try to receive a message (non-blocking).

pub async fn call<M>( &self, message: M, timeout: Duration, ) -> Result<MessageEnvelope, RingKernelError>

where M: RingMessage,

Send request and wait for response (call pattern).

pub fn status(&self) -> KernelStatus

Get kernel status.

pub fn metrics(&self) -> KernelMetrics

Get kernel metrics.

pub async fn wait(&self) -> Result<(), RingKernelError>

Wait for kernel to terminate.

pub fn state(&self) -> KernelState

Get the current kernel state.

This is a convenience method that returns just the state from status().

pub async fn suspend(&self) -> Result<(), RingKernelError>

Suspend (deactivate) the kernel.

This is an alias for deactivate() for more intuitive API usage.

pub async fn resume(&self) -> Result<(), RingKernelError>

Resume (activate) the kernel.

This is an alias for activate() for more intuitive API usage.

pub fn is_active(&self) -> bool

Check if the kernel is currently active.

pub fn is_terminated(&self) -> bool

Check if the kernel has terminated.

Trait Implementations

impl Clone for KernelHandle

fn clone(&self) -> KernelHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KernelHandle

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

Formats the value using the given formatter.