Skip to main content

DataHandle

Struct DataHandle 

Source
pub struct DataHandle<Req, Rsp> {
    pub consumer: Consumer<Req>,
    pub producer: Producer<Rsp>,
    pub backpressure: Arc<BackpressureController>,
    pub req_wake: Arc<WakePair>,
    pub rsp_wake: Arc<WakePair>,
}
Expand description

Handle held by the Data Plane (TPC core).

This type is Send so it can be transferred to a TPC core during setup. Call .pin() once on the target core to get a PinnedDataHandle which is !Send — enforcing at compile time that it stays on that core forever.

Fields§

§consumer: Consumer<Req>

Receive requests from the Control Plane.

§producer: Producer<Rsp>

Send responses back to the Control Plane.

§backpressure: Arc<BackpressureController>

Backpressure state for the request queue (read-only from Data Plane).

§req_wake: Arc<WakePair>

Wakers for the request channel.

§rsp_wake: Arc<WakePair>

Wakers for the response channel.

Implementations§

Source§

impl<Req, Rsp> DataHandle<Req, Rsp>

Source

pub fn pin(self) -> PinnedDataHandle<Req, Rsp>

Pin this handle to the current TPC core.

Returns a PinnedDataHandle which is !Send — the compiler will reject any attempt to move it to another thread.

Call this exactly once, on the target TPC core, during setup.

Source

pub fn try_recv_request(&mut self) -> Result<Req>

Try to receive a request from the Control Plane.

Source

pub fn drain_requests(&mut self, buf: &mut Vec<Req>, max: usize) -> usize

Drain up to max requests into the buffer.

Source

pub fn try_send_response(&mut self, rsp: Rsp) -> Result<()>

Try to send a response back to the Control Plane.

Source

pub fn pressure(&self) -> PressureState

Current backpressure state (read by Data Plane to decide I/O depth).

Source

pub fn should_throttle(&self) -> bool

Whether the Data Plane should reduce read depth.

Source

pub fn should_suspend(&self) -> bool

Whether the Data Plane should suspend new reads entirely.

Source

pub fn request_wake_fd(&self) -> RawFd

Raw fd for the request-available signal (register with TPC event loop).

Source

pub fn response_space_fd(&self) -> RawFd

Raw fd for the response-space-available signal.

Auto Trait Implementations§

§

impl<Req, Rsp> Freeze for DataHandle<Req, Rsp>

§

impl<Req, Rsp> !RefUnwindSafe for DataHandle<Req, Rsp>

§

impl<Req, Rsp> Send for DataHandle<Req, Rsp>
where Req: Send, Rsp: Send,

§

impl<Req, Rsp> Sync for DataHandle<Req, Rsp>
where Req: Send, Rsp: Send,

§

impl<Req, Rsp> Unpin for DataHandle<Req, Rsp>

§

impl<Req, Rsp> UnsafeUnpin for DataHandle<Req, Rsp>

§

impl<Req, Rsp> !UnwindSafe for DataHandle<Req, Rsp>

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

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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> 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> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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