Skip to main content

BasicActionClient

Struct BasicActionClient 

Source
pub struct BasicActionClient<G, F, R> { /* private fields */ }

Implementations§

Source§

impl<G, F, R> BasicActionClient<G, F, R>

Source

pub fn new(action_name: impl Into<String>, schema: ActionSchema) -> Self

Source

pub fn with_channel( action_name: impl Into<String>, schema: ActionSchema, channel: Arc<ActionChannel<G, F, R>>, ) -> Self

Source

pub fn with_heartbeat_timeout(self, timeout: Option<RtDuration>) -> Self

Source

pub fn with_stalled_threshold(self, stalled_after: Option<RtDuration>) -> Self

Trait Implementations§

Source§

impl<G, F, R> ActionClient<G, F, R> for BasicActionClient<G, F, R>
where G: Send + 'static, F: Send + 'static, R: Send + 'static,

Source§

fn action_name(&self) -> &str

Source§

fn schema(&self) -> &ActionSchema

Source§

fn send_goal(&mut self, goal: G) -> Result<(ActionGoalId, GoalAck), RtError>

Send a goal and immediately receive the server’s accept/reject acknowledgement. Read more
Source§

fn poll_feedback(&mut self, goal_id: ActionGoalId) -> Option<ActionFeedback<F>>

Non-blocking poll: dequeue the next feedback item for the given goal, or None if empty.
Source§

fn poll_result(&mut self, goal_id: ActionGoalId) -> Option<ActionResult<R>>

Non-blocking poll: take the final result for the given goal, or None if not ready. Read more
Source§

fn cancel(&mut self, goal_id: ActionGoalId) -> Result<(), RtError>

Request cancellation of a goal. Read more
Source§

fn goal_status(&self, goal_id: ActionGoalId) -> Option<GoalStatus>

Query the current status of a goal without consuming any feedback or result.
Source§

fn tick_timeouts(&mut self, now: Timestamp) -> usize

Evaluate heartbeat timeouts for executing goals. Read more
Source§

fn goal_health(&self, goal_id: ActionGoalId) -> Option<ActionSessionHealth>

Return health state of a specific goal.
Source§

fn active_goal_health(&self) -> Vec<ActionSessionHealth>

Return health states for all known goals.
Source§

fn close(&mut self) -> Result<(), RtError>

Auto Trait Implementations§

§

impl<G, F, R> Freeze for BasicActionClient<G, F, R>

§

impl<G, F, R> RefUnwindSafe for BasicActionClient<G, F, R>

§

impl<G, F, R> Send for BasicActionClient<G, F, R>
where G: Send, F: Send, R: Send,

§

impl<G, F, R> Sync for BasicActionClient<G, F, R>
where G: Sync + Send, F: Sync + Send, R: Sync + Send,

§

impl<G, F, R> Unpin for BasicActionClient<G, F, R>
where G: Unpin, F: Unpin, R: Unpin,

§

impl<G, F, R> UnsafeUnpin for BasicActionClient<G, F, R>

§

impl<G, F, R> UnwindSafe for BasicActionClient<G, F, R>
where G: UnwindSafe, F: UnwindSafe, R: UnwindSafe,

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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