This object waits on a set of open message queue file descriptors and signals the channel that has received new data. More...

#include <rtt/transports/mqueue/Dispatcher.hpp>

Inheritance diagram for RTT::mqueue::Dispatcher:

List of all members.

Public Types
typedef boost::intrusive_ptr < Dispatcher >	shared_ptr
Public Member Functions
void	addQueue (mqd_t mqdes, base::ChannelElementBase *chan)
void	removeQueue (mqd_t mqdes)
bool	initialize ()
void	loop ()
bool	breakLoop ()
virtual bool	start ()
	Start the activity.
virtual bool	execute ()
	Execute this activity such that it executes a step or loop of the RunnableInterface.
virtual bool	trigger ()
	Trigger that work has to be done.
virtual bool	stop ()
	Stop the activity This will stop the activity by removing it from the 'run-queue' of a thread or call RunnableInterface::breakLoop().
virtual bool	isRunning () const
	Query if the activity is initialized and executing.
virtual bool	isActive () const
	Query if the activity is started.
virtual bool	isPeriodic () const
	Inspect if this activity is periodic.
virtual Seconds	getPeriod () const
	Get the periodicity of this activity in Seconds.
void	getPeriod (secs &s, nsecs &ns) const
	Get the periodicity of this thread (seconds, nanoseconds)
virtual bool	setPeriod (Seconds period)
	Set the periodicity of this activity in Seconds.
bool	setPeriod (secs s, nsecs ns)
	Set the periodicity of this thread (seconds, nanoseconds)
bool	setPeriod (TIME_SPEC p)
	Set the periodicity of this thread.
virtual unsigned	getCpuAffinity () const
	Get the cpu affinity of this activity.
virtual bool	setCpuAffinity (unsigned cpu)
	Set the cpu affinity of this activity.
virtual os::ThreadInterface *	thread ()
	Returns a pointer to the thread which will run this activity.
virtual void	step ()
virtual void	finalize ()
virtual bool	run (RunnableInterface *r)
	Run exclusively this RunnableInterface.
virtual nsecs	getPeriodNS () const
	Get the periodicity in nanoseconds.
virtual const char *	getName () const
	Read the name of this task.
virtual RTOS_TASK *	getTask ()
	Get the RTOS_TASK pointer.
virtual const RTOS_TASK *	getTask () const
	const version of the above.
virtual bool	setScheduler (int sched_type)
	Change the scheduler policy in which this thread runs.
virtual int	getScheduler () const
	Get the scheduler policy in which this thread runs.
virtual bool	setPriority (int priority)
	Set the priority of this Thread.
virtual int	getPriority () const
	The priority of this Thread.
virtual void	yield ()
	Yields (put to the back of the scheduler queue) the calling thread.
virtual void	setMaxOverrun (int m)
virtual int	getMaxOverrun () const
virtual void	setWaitPeriodPolicy (int p)
	Set the wait policy of a periodic thread.
unsigned int	threadNumber () const
	The unique thread number (within the same process).
bool	isSelf () const
Static Public Member Functions
static Dispatcher::shared_ptr	Instance ()
static void	setStackSize (unsigned int ssize)
	Sets the stack size of the threads to be created.
Protected Member Functions
void	disableRun (RunnableInterface *caller)
	This method is only meant for RunnableInterface (ie runner) in order to inform the ActivityInterface it should no longer be used.
void	terminate ()
	Exit and destroy the thread.
void	emergencyStop ()
Protected Attributes
RunnableInterface *	runner
int	threadnb
	Threads are given an unique number, which follows thread creation order.
Friends
void	intrusive_ptr_add_ref (const RTT::mqueue::Dispatcher *p)
void	intrusive_ptr_release (const RTT::mqueue::Dispatcher *p)
class	RunnableInterface

Detailed Description

This object waits on a set of open message queue file descriptors and signals the channel that has received new data.

Reasonably, there should be one dispatcher for each peer component sending us data.

Definition at line 62 of file Dispatcher.hpp.

Member Function Documentation

bool RTT::mqueue::Dispatcher::breakLoop ( ) [inline, virtual]

See also:: base::RunnableInterface::breakLoop()

Reimplemented from RTT::Activity.

Definition at line 208 of file Dispatcher.hpp.

void RTT::base::ActivityInterface::disableRun ( RunnableInterface * caller ) [inline, protected, inherited]

This method is only meant for RunnableInterface (ie runner) in order to inform the ActivityInterface it should no longer be used.

run(0) can not be used in this case because it would recurse.

Definition at line 73 of file ActivityInterface.hpp.

Referenced by RTT::base::RunnableInterface::setActivity(), and RTT::base::RunnableInterface::~RunnableInterface().

bool RTT::Activity::execute ( ) [virtual, inherited]

Execute this activity such that it executes a step or loop of the RunnableInterface.

When you invoke execute() you intend to call the step() or loop() methods. Some activity implementations allow a user controlled execute, others ignore it, in which case execute() returns false.

Semantics: If execute() returns true, the activity has been executed exactly once during execute().

Return values:

true	When this->isActive() and the implementation allows external executes.
false	When !this->isActive() or the implementation does not allow external updating.

See also:: trigger() for use in callbacks which want execute() to be executed.

Implements RTT::base::ActivityInterface.

Definition at line 131 of file Activity.cpp.

void RTT::Activity::finalize ( ) [virtual, inherited]

See also:: base::RunnableInterface::finalize()

Reimplemented from RTT::os::Thread.

Reimplemented in RTT::corba::OrbRunner.

Definition at line 113 of file Activity.cpp.

References RTT::base::RunnableInterface::finalize().

unsigned RTT::Activity::getCpuAffinity ( ) const [virtual, inherited]

Get the cpu affinity of this activity.

Returns:: The cpu affinity of this activity.

Implements RTT::base::ActivityInterface.

Definition at line 158 of file Activity.cpp.

Seconds RTT::Activity::getPeriod ( ) const [virtual, inherited]

Get the periodicity of this activity in Seconds.

Returns:: The execution period of this activity (zero if !this->isPeriodic() ).

Implements RTT::base::ActivityInterface.

Definition at line 143 of file Activity.cpp.

nsecs RTT::os::Thread::getPeriodNS ( ) const [virtual, inherited]

Get the periodicity in nanoseconds.

Return zero if non periodic.

Implements RTT::os::ThreadInterface.

Definition at line 583 of file Thread.cpp.

int RTT::os::Thread::getPriority ( ) const [virtual, inherited]

The priority of this Thread.

Returns:: The priority given upon construction of this thread or set with setPriority. The returned number has to be interpreted in the current OS scheduler.

See also:: setScheduler

Implements RTT::os::ThreadInterface.

Definition at line 573 of file Thread.cpp.

References RTT::os::rtos_task_get_priority().

Referenced by RTT::extras::SimulationThread::SimulationThread().

int RTT::os::Thread::getScheduler ( ) const [virtual, inherited]

Get the scheduler policy in which this thread runs.

Returns:: An OS-specific value which represents the used scheduler.

See also:: setScheduler

Implements RTT::os::ThreadInterface.

Definition at line 475 of file Thread.cpp.

References RTT::os::rtos_task_get_scheduler().

Referenced by RTT::os::Thread::setScheduler().

virtual RTOS_TASK* RTT::os::Thread::getTask ( ) [inline, virtual, inherited]

Get the RTOS_TASK pointer.

Note:: Using this function leads to non-portable code. It is here for users which wish to tweak OS specific thread settings.

Implements RTT::os::ThreadInterface.

Definition at line 174 of file Thread.hpp.

Referenced by RTT::os::thread_function().

bool RTT::mqueue::Dispatcher::initialize ( ) [inline, virtual]

See also:: base::RunnableInterface::initialize()

Reimplemented from RTT::Activity.

Definition at line 166 of file Dispatcher.hpp.

bool RTT::Activity::isActive ( ) const [virtual, inherited]

Query if the activity is started.

This is less strict than isRunning(), it is true during initialize(), step() or loop() and finalize(). Use this method to check if an activity was start()ed.

Returns:: true if it is active, false otherwise

Implements RTT::base::ActivityInterface.

Definition at line 139 of file Activity.cpp.

Referenced by RTT::Activity::trigger().

bool RTT::Activity::isPeriodic ( ) const [virtual, inherited]

Inspect if this activity is periodic.

If so, it will call RunnableInterface::step(). If the activity is not periodic, it will call RunnableInterface::loop().

Returns:: true if periodic.

Implements RTT::base::ActivityInterface.

Definition at line 154 of file Activity.cpp.

bool RTT::Activity::isRunning ( ) const [virtual, inherited]

Query if the activity is initialized and executing.

This is more strict than isActive(), it is only true after initialize() is executed and before finalize() is executed. More-over, an Activity may decide to be temporarily not running (not executing code), waiting for a signal to proceed. If this->isActive() and !this->isRunning() then the Activity is in a waiting state.

Returns:: true if it is running, false otherwise

Implements RTT::base::ActivityInterface.

Reimplemented in RTT::extras::FileDescriptorActivity.

Definition at line 135 of file Activity.cpp.

void RTT::mqueue::Dispatcher::loop ( ) [inline, virtual]

See also:: base::RunnableInterface::loop()

Reimplemented from RTT::Activity.

Definition at line 171 of file Dispatcher.hpp.

bool ActivityInterface::run ( RunnableInterface * r ) [virtual, inherited]

Run exclusively this RunnableInterface.

Precondition:: this->isRunning() == false

Parameters:

r	The RunnableInterface to run exclusively.

Returns:: true if succeeded, false otherwise

Definition at line 57 of file ActivityInterface.cpp.

References RTT::base::ActivityInterface::isActive(), and RTT::base::RunnableInterface::setActivity().

Referenced by RTT::TaskContext::setActivity().

bool RTT::Activity::setCpuAffinity ( unsigned cpu ) [virtual, inherited]

Set the cpu affinity of this activity.

Returns:: true if it could be updated, false otherwise.

Implements RTT::base::ActivityInterface.

Definition at line 163 of file Activity.cpp.

bool RTT::Activity::setPeriod ( Seconds s ) [virtual, inherited]

Set the periodicity of this activity in Seconds.

Note that not all activity implementation support periods. A period of s == 0 indicates non periodic. A non supported setting returns false.

Returns:: true if it could be updated, false otherwise.

Implements RTT::base::ActivityInterface.

Definition at line 148 of file Activity.cpp.

bool RTT::os::Thread::setPriority ( int priority ) [virtual, inherited]

Set the priority of this Thread.

Parameters:

priority The priority given upon construction of this thread. It has to be interpreted in the current OS scheduler.

See also:: setScheduler

Implements RTT::os::ThreadInterface.

Definition at line 563 of file Thread.cpp.

References RTT::os::rtos_task_set_priority().

bool RTT::os::Thread::setScheduler ( int sched_type ) [virtual, inherited]

Change the scheduler policy in which this thread runs.

Parameters:

sched_type

An OS-specific value which selects a scheduler. Orocos requires that these two values are available:

ORO_SCHED_RT: Hint the OS that this thread should be scheduled as a priority or real-time process.
ORO_SCHED_OTHER: Hint the OS that this thread should not be scheduled as a priority or real-time process.

Your OS can in addition provide other sched_type's which map more naturally to the schedulers present. If your OS does not make a distinction between real-time and other, both values may map to the same scheduler type.

Returns:: true if the change could be made.

Implements RTT::os::ThreadInterface.

Definition at line 456 of file Thread.cpp.

References RTT::os::CheckScheduler(), RTT::os::Thread::getScheduler(), RTT::os::rtos_task_get_name(), and RTT::os::rtos_task_set_scheduler().

Referenced by RTT::extras::SimulationThread::SimulationThread().

void RTT::os::Thread::setStackSize ( unsigned int ssize ) [static, inherited]

Sets the stack size of the threads to be created.

This value is suggestive and may be altered or ignored by your operating system. Use zero to use the system's default.

Parameters:

ssize the size of the stack in bytes

Definition at line 73 of file Thread.cpp.

void RTT::os::Thread::setWaitPeriodPolicy ( int p ) [virtual, inherited]

Set the wait policy of a periodic thread.

Parameters:

The	wait policy between ORO_WAIT_ABS (absolute wait) and ORO_WAIT_REL (relative wait)

Implements RTT::os::ThreadInterface.

Definition at line 629 of file Thread.cpp.

References RTT::os::rtos_task_set_wait_period_policy().

bool RTT::Activity::start ( ) [virtual, inherited]

Start the activity.

This will call RunnableInterface::initialize() and upon success, effectively start the activity, by running the RunnableInterface::step() or RunnableInterface::loop() in a thread.

See also:: isPeriodic()

Returns:: true if the activity is started, false otherwise

Implements RTT::base::ActivityInterface.

Reimplemented in RTT::extras::FileDescriptorActivity, and RTT::extras::IRQActivity.

Definition at line 119 of file Activity.cpp.

Referenced by RTT::extras::FileDescriptorActivity::start(), and RTT::Activity::trigger().

void RTT::Activity::step ( ) [virtual, inherited]

See also:: base::RunnableInterface::step()

Reimplemented from RTT::os::Thread.

Reimplemented in RTT::extras::FileDescriptorActivity.

Definition at line 95 of file Activity.cpp.

References RTT::base::RunnableInterface::step().

Referenced by RTT::Activity::loop().

bool RTT::Activity::stop ( ) [virtual, inherited]

Stop the activity This will stop the activity by removing it from the 'run-queue' of a thread or call RunnableInterface::breakLoop().

If no errors occured, RunnableInterface::finalize() is called.

See also:: isPeriodic()

Returns:: true if the activity is stopped, false otherwise

Implements RTT::base::ActivityInterface.

Reimplemented in RTT::extras::FileDescriptorActivity.

Definition at line 123 of file Activity.cpp.

Referenced by RTT::Activity::~Activity().

void RTT::os::Thread::terminate ( ) [protected, inherited]

Exit and destroy the thread.

Precondition:: this is only called from within the destructor.

Postcondition:: the thread does no longer exist.

Definition at line 603 of file Thread.cpp.

References RTT::os::rtos_task_delete().

os::ThreadInterface * RTT::Activity::thread ( ) [virtual, inherited]

Returns a pointer to the thread which will run this activity.

Will not be null.

Implements RTT::base::ActivityInterface.

Definition at line 85 of file Activity.cpp.

bool RTT::Activity::trigger ( ) [virtual, inherited]

Trigger that work has to be done.

When you invoke trigger(), you intend to notify the mechanism that calls execute(), that execute() should be called. This allows a separation between actually executing code (execute()) and notifying that code must be executed (trigger()). A trigger may be ignored by the implementation, in which case trigger returns false.

Semantics: If trigger() returns true, the activity will be executed at least once from the moment trigger() is called.

Return values:

true	When this->isActive() and the implementation allows external triggers.
false	When !this->isActive() or the implementation does not allow external triggering.

Implements RTT::base::ActivityInterface.

Reimplemented in RTT::extras::FileDescriptorActivity.

Definition at line 127 of file Activity.cpp.

References RTT::Activity::isActive(), and RTT::Activity::start().