Struct ThreadHandle 

pub struct ThreadHandle { /* private fields */ }

A thread handle can be used from within the thread to read or modify certain settings like the name or the cpu affinity.

Example

use iceoryx2_bb_posix::thread::*;

let mut handle = ThreadHandle::from_self();
println!("I am running in a thread named {}", handle.get_name().expect(""));
println!("On the following CPU cores {:?}", handle.get_affinity().expect(""));

// only run on CPU 0
handle.set_affinity(0);

Implementations

impl ThreadHandle

pub fn from_self() -> ThreadHandle

Returns a handle to the callers thread.

Trait Implementations

impl Debug for ThreadHandle

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

Formats the value using the given formatter.

impl ThreadProperties for ThreadHandle

fn get_name(&self) -> Result<&ThreadName, ThreadGetNameError>

Returns the name of the thread.

fn get_affinity(&self) -> Result<Vec<usize>, ThreadSetAffinityError>

Returns a vector of numbers which represents the CPU cores in which the thread may run.

fn set_affinity( &mut self, cpu_core_ids: &[usize], ) -> Result<(), ThreadSetAffinityError>

Sets the threads affinity to the provided set of cpu core ids. If one of the cpu core id’s does not exist in the system the call will fail.