iceoryx_posh 2.0.3
Public Member Functions | Friends | List of all members
iox::popo::UserTrigger Class Reference

An event based trigger which can be used by the application developer directly. If you would like to trigger a WaitSet/Listener through an event of your class you should use the Trigger class. More...

#include <iceoryx_posh/popo/user_trigger.hpp>

Public Member Functions

 UserTrigger (const UserTrigger &rhs)=delete
 
 UserTrigger (UserTrigger &&rhs)=delete
 
UserTriggeroperator= (const UserTrigger &rhs)=delete
 
UserTriggeroperator= (UserTrigger &&rhs)=delete
 
void trigger () noexcept
 If it is attached it will trigger otherwise it will do nothing. More...
 
bool hasTriggered () const noexcept
 Checks if the UserTrigger was triggered. More...
 

Friends

class NotificationAttorney
 

Detailed Description

An event based trigger which can be used by the application developer directly. If you would like to trigger a WaitSet/Listener through an event of your class you should use the Trigger class.

Member Function Documentation

◆ hasTriggered()

bool iox::popo::UserTrigger::hasTriggered ( ) const
noexcept

Checks if the UserTrigger was triggered.

Returns
true if the UserTrigger is trigger, otherwise false.
Note
The hasTrigger state will be reset after it was handled by a WaitSet/Listener

◆ trigger()

void iox::popo::UserTrigger::trigger ( )
noexcept

If it is attached it will trigger otherwise it will do nothing.

Note
a user trigger cannot be triggered when it is not attached

The documentation for this class was generated from the following file: