dpdk-core 0.1.5

A wrapper around DPDK's core framework
// This file is part of dpdk. It is subject to the license terms in the COPYRIGHT file found in the top-level directory of this distribution and at https://raw.githubusercontent.com/lemonrock/dpdk/master/COPYRIGHT. No part of dpdk, including this file, may be copied, modified, propagated, or distributed except according to the terms contained in the COPYRIGHT file.
// Copyright © 2016-2018 The developers of dpdk. See the COPYRIGHT file in the top-level directory of this distribution and at https://raw.githubusercontent.com/lemonrock/dpdk/master/COPYRIGHT.


/// Should the function running on the current logical core terminate?
#[derive(Debug)]
pub struct ShouldFunctionTerminate(AtomicBool);

unsafe impl Send for ShouldFunctionTerminate
{
}

unsafe impl Sync for ShouldFunctionTerminate
{
}

impl ShouldFunctionTerminate
{
	const Sleepiness: Duration = Duration::from_millis(10);
	
	/// New instance.
	#[inline(always)]
	pub fn new() -> Arc<ShouldFunctionTerminate>
	{
		Arc::new(ShouldFunctionTerminate(AtomicBool::new(false)))
	}
	
	/// Should we terminate?
	#[inline(always)]
	pub fn should_terminate(&self) -> bool
	{
		self.0.load(Relaxed)
	}
	
	/// Should we continue?
	#[inline(always)]
	pub fn should_continue(&self) -> bool
	{
		!self.should_terminate()
	}
	
	/// Sleep and check for terminate.
	#[inline(always)]
	pub fn sleep_and_check_should_terminate(&self) -> bool
	{
		::std::thread::sleep(Self::Sleepiness);
		self.should_terminate()
	}
	
	/// A thread-like function panicked; terminate.
	#[inline(always)]
	pub fn we_panicked(&self, payload: &(Any + 'static + Send))
	{
		SysLog::caught_unwind(payload);
		
		self.0.store(true, SeqCst)
	}
	
	/// The master loop was signalled (caught a signal) that was interpreted as meanining 'exit'.
	#[inline(always)]
	pub fn exit_signalled(&self, signal_number: Option<SignalNumber>)
	{
		SysLog::exit_signalled(signal_number);
		
		self.0.store(true, SeqCst)
	}
}