Mir
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | List of all members
mir::AsioMainLoop Class Reference

#include <asio_main_loop.h>

Inheritance diagram for mir::AsioMainLoop:
[legend]

Public Member Functions

 AsioMainLoop (std::shared_ptr< time::Clock > const &clock)
 
 ~AsioMainLoop () noexcept(true)
 
void run ()
 
void stop ()
 
void register_signal_handler (std::initializer_list< int > signals, std::function< void(int)> const &handler)
 
void register_fd_handler (std::initializer_list< int > fd, void const *owner, std::function< void(int)> const &handler) override
 
void unregister_fd_handler (void const *owner) override
 
std::unique_ptr< time::Alarmnotify_in (std::chrono::milliseconds delay, std::function< void()> callback) override
 Create an Alarm that calls the callback after the specified delay. More...
 
std::unique_ptr< time::Alarmnotify_at (mir::time::Timestamp time_point, std::function< void()> callback) override
 Create an Alarm that calls the callback at the specified time. More...
 
std::unique_ptr< time::Alarmcreate_alarm (std::function< void()> callback) override
 Create an Alarm that will not fire until scheduled. More...
 
void enqueue (void const *owner, ServerAction const &action)
 
void pause_processing_for (void const *owner)
 
void resume_processing_for (void const *owner)
 
- Public Member Functions inherited from mir::time::Timer
 Timer ()=default
 
virtual ~Timer ()=default
 
 Timer (Timer const &)=delete
 
Timeroperator= (Timer const &)=delete
 
- Public Member Functions inherited from mir::ServerActionQueue
virtual ~ServerActionQueue ()=default
 

Additional Inherited Members

- Protected Member Functions inherited from mir::graphics::EventHandlerRegister
 EventHandlerRegister ()=default
 
virtual ~EventHandlerRegister ()=default
 
 EventHandlerRegister (EventHandlerRegister const &)=delete
 
EventHandlerRegisteroperator= (EventHandlerRegister const &)=delete
 
- Protected Member Functions inherited from mir::ServerActionQueue
 ServerActionQueue ()=default
 
 ServerActionQueue (ServerActionQueue const &)=delete
 
ServerActionQueueoperator= (ServerActionQueue const &)=delete
 

Constructor & Destructor Documentation

mir::AsioMainLoop::AsioMainLoop ( std::shared_ptr< time::Clock > const &  clock)
explicit
mir::AsioMainLoop::~AsioMainLoop ( )
noexcept

Member Function Documentation

std::unique_ptr< mir::time::Alarm > mir::AsioMainLoop::create_alarm ( std::function< void()>  callback)
overridevirtual

Create an Alarm that will not fire until scheduled.

Parameters
callbackFunction to call when the Alarm signals
Returns
A handle to an Alarm that can later be scheduled

Implements mir::time::Timer.

void mir::AsioMainLoop::enqueue ( void const *  owner,
ServerAction const &  action 
)
virtual
std::unique_ptr< mir::time::Alarm > mir::AsioMainLoop::notify_at ( mir::time::Timestamp  time_point,
std::function< void()>  callback 
)
overridevirtual

Create an Alarm that calls the callback at the specified time.

Parameters
time_pointTime point when the alarm should be triggered
callbackFunction to call when the Alarm signals
Returns
A handle to an Alarm that will fire after delay ms.

Implements mir::time::Timer.

std::unique_ptr< mir::time::Alarm > mir::AsioMainLoop::notify_in ( std::chrono::milliseconds  delay,
std::function< void()>  callback 
)
overridevirtual

Create an Alarm that calls the callback after the specified delay.

Parameters
delayTime from now, in milliseconds, that the callback will fire
callbackFunction to call when the Alarm signals
Returns
A handle to an Alarm that will fire after delay ms.

Implements mir::time::Timer.

void mir::AsioMainLoop::pause_processing_for ( void const *  owner)
virtual
void mir::AsioMainLoop::register_fd_handler ( std::initializer_list< int >  fd,
void const *  owner,
std::function< void(int)> const &  handler 
)
overridevirtual
void mir::AsioMainLoop::register_signal_handler ( std::initializer_list< int >  signals,
std::function< void(int)> const &  handler 
)
virtual
void mir::AsioMainLoop::resume_processing_for ( void const *  owner)
virtual
void mir::AsioMainLoop::run ( )
virtual

Implements mir::MainLoop.

void mir::AsioMainLoop::stop ( )
virtual

Implements mir::MainLoop.

void mir::AsioMainLoop::unregister_fd_handler ( void const *  owner)
overridevirtual

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

Copyright © 2012,2013 Canonical Ltd.
Generated on Fri Oct 10 14:07:14 UTC 2014