pub struct BasicActionClient<G, F, R> { /* private fields */ }Implementations§
Source§impl<G, F, R> BasicActionClient<G, F, R>
impl<G, F, R> BasicActionClient<G, F, R>
pub fn new(action_name: impl Into<String>, schema: ActionSchema) -> Self
pub fn with_channel( action_name: impl Into<String>, schema: ActionSchema, channel: Arc<ActionChannel<G, F, R>>, ) -> Self
pub fn with_heartbeat_timeout(self, timeout: Option<RtDuration>) -> Self
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>
impl<G, F, R> ActionClient<G, F, R> for BasicActionClient<G, F, R>
fn action_name(&self) -> &str
fn schema(&self) -> &ActionSchema
Source§fn send_goal(&mut self, goal: G) -> Result<(ActionGoalId, GoalAck), RtError>
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>>
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>>
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 moreSource§fn cancel(&mut self, goal_id: ActionGoalId) -> Result<(), RtError>
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>
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
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>
fn goal_health(&self, goal_id: ActionGoalId) -> Option<ActionSessionHealth>
Return health state of a specific goal.
Source§fn active_goal_health(&self) -> Vec<ActionSessionHealth>
fn active_goal_health(&self) -> Vec<ActionSessionHealth>
Return health states for all known goals.
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>
impl<G, F, R> Sync for BasicActionClient<G, F, R>
impl<G, F, R> Unpin for BasicActionClient<G, F, R>
impl<G, F, R> UnsafeUnpin for BasicActionClient<G, F, R>
impl<G, F, R> UnwindSafe for BasicActionClient<G, F, R>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more