Struct libp2p_core::nodes::tasks::TaskEntry

pub struct TaskEntry<'a, E, T> { /* fields omitted */ }

Access to a task in the collection.

Methods

impl<'a, E, T> TaskEntry<'a, E, T>

pub fn start_send_event(&mut self, event: E)

Begin sending an event to the given node. Must be called only after a successful call to poll_ready_event.

pub fn poll_ready_event(&mut self, cx: &mut Context) -> Poll<()>

Make sure we are ready to accept an event to be sent with start_send_event.

pub fn user_data(&self) -> &T

Returns the user data associated with the task.

pub fn user_data_mut(&mut self) -> &mut T

Returns the user data associated with the task.

pub fn id(&self) -> TaskId

Returns the task id.

pub fn close(self) -> ClosedTask<E, T>

Closes the task. Returns the user data.

No further event will be generated for this task, but the connection inside the task will continue to run until the ClosedTask is destroyed.

pub fn start_take_over(&mut self, t: ClosedTask<E, T>)

Gives ownership of a closed task. As soon as our task (self) has some acknowledgment from the remote that its connection is alive, it will close the connection with other.

Must be called only after a successful call to poll_ready_take_over.

pub fn poll_ready_take_over(&mut self, cx: &mut Context) -> Poll<()>

Make sure we are ready to taking over with start_take_over.

Trait Implementations

impl<'_, E, T: Debug> Debug for TaskEntry<'_, E, T>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.