processes::mail_stop Class Reference
Base class for routes on which letters are automatically delivered. More...
#include <mail_stop.h>
Classes | |
| class | items_to_deliver |
Public Member Functions | |
| virtual void | delivery_for_you (const structures::unique_int &id, letter *package)=0 |
| the derived object must provide this function. | |
Protected Member Functions | |
| virtual void | real_callback (callback_data_block &data) |
| invoked by the safe callback machinery. | |
Detailed Description
Base class for routes on which letters are automatically delivered.
The letters will show up for a particular unique id at this mail stop. They are delivered by the object serving as the post office.
Definition at line 30 of file mail_stop.h.
Member Function Documentation
| virtual void processes::mail_stop::delivery_for_you | ( | const structures::unique_int & | id, | |
| letter * | package | |||
| ) | [pure virtual] |
the derived object must provide this function.
prompts the recipient with the "id" to accept delivery of a "package". the package can be modified as desired and MUST be recycled before returning from this function. IMPORTANT NOTE: the receiver MUST be thread-safe with respect to the objects that it uses to handle this delivery! this is because mail is delivered on a thread other than the main program thread.
| virtual void processes::mail_stop::real_callback | ( | callback_data_block & | data | ) | [inline, protected, virtual] |
invoked by the safe callback machinery.
this is implemented in this class and merely re-routes the call to the more specific delivery_for_you() method.
Implements processes::safe_callback.
Definition at line 58 of file mail_stop.h.
The documentation for this class was generated from the following file:
- /var/www/hoople2/source/core/library/processes/mail_stop.h
