DBus::Timeout Class Reference
#include <dispatcher.h>
Public Member Functions | |
| Timeout (Internal *i) | |
| virtual | ~Timeout () |
| int | interval () const |
| Gets the timeout interval. | |
| bool | enabled () const |
| bool | handle () |
| Calls the timeout handler for this timeout. | |
| virtual void | toggle ()=0 |
Private Member Functions | |
| DXXAPILOCAL | Timeout (const Timeout &) |
Private Attributes | |
| Internal * | _int |
Detailed Description
Definition at line 35 of file dispatcher.h.
Constructor & Destructor Documentation
| DBus::Timeout::Timeout | ( | Internal * | i | ) |
| virtual DBus::Timeout::~Timeout | ( | ) | [inline, virtual] |
Definition at line 43 of file dispatcher.h.
| DXXAPILOCAL DBus::Timeout::Timeout | ( | const Timeout & | ) | [private] |
Member Function Documentation
| bool Timeout::enabled | ( | ) | const |
Definition at line 51 of file dispatcher.cpp.
References _int.
Referenced by DBus::Glib::BusDispatcher::add_timeout(), DBus::Ecore::BusDispatcher::add_timeout(), DBus::Glib::BusTimeout::BusTimeout(), DBus::BusTimeout::BusTimeout(), DBus::Ecore::BusTimeout::BusTimeout(), DBus::Glib::BusTimeout::toggle(), DBus::BusTimeout::toggle(), and DBus::Ecore::BusTimeout::toggle().
| bool Timeout::handle | ( | ) |
Calls the timeout handler for this timeout.
This function should be called when the timeout occurs.
If this function returns FALSE, then there wasn't enough memory to handle the timeout. Typically just letting the timeout fire again next time it naturally times out is an adequate response to that problem, but you could try to do more if you wanted.
return false If there wasn't enough memory.
Definition at line 56 of file dispatcher.cpp.
References _int.
Referenced by DBus::BusDispatcher::timeout_expired(), DBus::Glib::BusTimeout::timeout_handler(), and DBus::Ecore::BusTimeout::timeout_handler().
| int Timeout::interval | ( | ) | const |
Gets the timeout interval.
The handle() should be called each time this interval elapses, starting after it elapses once.
The interval may change during the life of the timeout; if so, the timeout will be disabled and re-enabled (calling the "timeout toggled function") to notify you of the change.
return The interval in miliseconds.
Definition at line 46 of file dispatcher.cpp.
References _int.
Referenced by DBus::Glib::BusTimeout::_enable(), and DBus::Ecore::BusTimeout::_enable().
| virtual void DBus::Timeout::toggle | ( | ) | [pure virtual] |
Implemented in DBus::Ecore::BusTimeout, DBus::BusTimeout, and DBus::Glib::BusTimeout.
Member Data Documentation
Internal* DBus::Timeout::_int [private] |
Definition at line 83 of file dispatcher.h.
Referenced by enabled(), handle(), and interval().
The documentation for this class was generated from the following files: