Struct roboplc::thread_rt::Builder

pub struct Builder { /* private fields */ }

A thread builder object, similar to thread::Builder but with real-time capabilities

Warning: works on Linux systems only

Implementations

impl Builder

pub fn new() -> Self

pub fn name<N: Display>(self, name: N) -> Self

The task name SHOULD be 15 characters or less to set a proper thread name

pub fn stack_size(self, size: usize) -> Self

Overrides the default stack size

pub fn blocking(self, blocking: bool) -> Self

A hint for task supervisors that the task blocks the thread (e.g. listens to a socket or has got a big interval in the main loop, does not return any useful result and should not be joined)

For scoped tasks: the task may be still forcibly joined at the end of the scope

pub fn rt_params(self, rt_params: RTParams) -> Self

Applies real-time parameters to the task

See RTParams

pub fn spawn<F, T>(self, f: F) -> Result<Task<T>>

where F: FnOnce() -> T + Send + 'static, T: Send + 'static,

Spawns a task

Errors

Returns errors if the task real-time parameters were set but have been failed to apply. The task thread is stopped and panicked

pub fn spawn_periodic<F, T>(self, f: F, interval: Interval) -> Result<Task<T>>

where F: Fn() -> T + Send + 'static, T: Send + 'static,

Spawns a periodic task

Errors

Returns errors if the task real-time parameters were set but have been failed to apply. The task thread is stopped and panicked

pub fn spawn_scoped<'scope, 'env, F, T>( self, scope: &'scope Scope<'scope, 'env>, f: F ) -> Result<ScopedTask<'scope, T>>

where F: FnOnce() -> T + Send + 'scope, T: Send + 'scope,

Spawns a scoped task

The standard Rust thread Scope is used.

Errors

Returns errors if the task real-time parameters were set but have been failed to apply. The task thread is stopped and panicked

pub fn spawn_scoped_periodic<'scope, 'env, F, T>( self, scope: &'scope Scope<'scope, 'env>, f: F, interval: Interval ) -> Result<ScopedTask<'scope, T>>

where F: Fn() -> T + Send + 'scope, T: Send + 'scope,

Spawns a scoped periodic task

The standard Rust thread Scope is used.

Errors

Returns errors if the task real-time parameters were set but have been failed to apply. The task thread is stopped and panicked

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl From<&str> for Builder

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for Builder

fn from(s: String) -> Self

Converts to this type from the input type.