Daniel Peter
core/netservice.h@0:98aadd37a5c5, 2010-09-29 (annotated)
- Committer:
- mbed714
- Date:
- Wed Sep 29 19:48:03 2010 +0000
- Revision:
- 0:98aadd37a5c5
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| mbed714 | 0:98aadd37a5c5 | 1 | |
| mbed714 | 0:98aadd37a5c5 | 2 | /* |
| mbed714 | 0:98aadd37a5c5 | 3 | Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com) |
| mbed714 | 0:98aadd37a5c5 | 4 | |
| mbed714 | 0:98aadd37a5c5 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy |
| mbed714 | 0:98aadd37a5c5 | 6 | of this software and associated documentation files (the "Software"), to deal |
| mbed714 | 0:98aadd37a5c5 | 7 | in the Software without restriction, including without limitation the rights |
| mbed714 | 0:98aadd37a5c5 | 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| mbed714 | 0:98aadd37a5c5 | 9 | copies of the Software, and to permit persons to whom the Software is |
| mbed714 | 0:98aadd37a5c5 | 10 | furnished to do so, subject to the following conditions: |
| mbed714 | 0:98aadd37a5c5 | 11 | |
| mbed714 | 0:98aadd37a5c5 | 12 | The above copyright notice and this permission notice shall be included in |
| mbed714 | 0:98aadd37a5c5 | 13 | all copies or substantial portions of the Software. |
| mbed714 | 0:98aadd37a5c5 | 14 | |
| mbed714 | 0:98aadd37a5c5 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| mbed714 | 0:98aadd37a5c5 | 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| mbed714 | 0:98aadd37a5c5 | 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| mbed714 | 0:98aadd37a5c5 | 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| mbed714 | 0:98aadd37a5c5 | 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| mbed714 | 0:98aadd37a5c5 | 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
| mbed714 | 0:98aadd37a5c5 | 21 | THE SOFTWARE. |
| mbed714 | 0:98aadd37a5c5 | 22 | */ |
| mbed714 | 0:98aadd37a5c5 | 23 | |
| mbed714 | 0:98aadd37a5c5 | 24 | /** |
| mbed714 | 0:98aadd37a5c5 | 25 | \file Net Service base class header file |
| mbed714 | 0:98aadd37a5c5 | 26 | */ |
| mbed714 | 0:98aadd37a5c5 | 27 | |
| mbed714 | 0:98aadd37a5c5 | 28 | #ifndef NETSERVICE_H |
| mbed714 | 0:98aadd37a5c5 | 29 | #define NETSERVICE_H |
| mbed714 | 0:98aadd37a5c5 | 30 | |
| mbed714 | 0:98aadd37a5c5 | 31 | #include <list> |
| mbed714 | 0:98aadd37a5c5 | 32 | using std::list; |
| mbed714 | 0:98aadd37a5c5 | 33 | |
| mbed714 | 0:98aadd37a5c5 | 34 | ///Net Service base class |
| mbed714 | 0:98aadd37a5c5 | 35 | /** |
| mbed714 | 0:98aadd37a5c5 | 36 | Each connection-oriented object can register as service (by inheriting this class), so that it is polled regularly. |
| mbed714 | 0:98aadd37a5c5 | 37 | It notifies the pool when the connection is terminated so that it can be destroyed. |
| mbed714 | 0:98aadd37a5c5 | 38 | */ |
| mbed714 | 0:98aadd37a5c5 | 39 | class NetService |
| mbed714 | 0:98aadd37a5c5 | 40 | { |
| mbed714 | 0:98aadd37a5c5 | 41 | public: |
| mbed714 | 0:98aadd37a5c5 | 42 | ///Instantiates a new service |
| mbed714 | 0:98aadd37a5c5 | 43 | /** |
| mbed714 | 0:98aadd37a5c5 | 44 | @param owned If true the object is owned by the pool and will be destroyed on closure. |
| mbed714 | 0:98aadd37a5c5 | 45 | */ |
| mbed714 | 0:98aadd37a5c5 | 46 | NetService(bool owned = true); //Is owned by the pool? |
| mbed714 | 0:98aadd37a5c5 | 47 | virtual ~NetService(); |
| mbed714 | 0:98aadd37a5c5 | 48 | |
| mbed714 | 0:98aadd37a5c5 | 49 | ///This method can be inherited so that it is called on each @a Net::poll() call. |
| mbed714 | 0:98aadd37a5c5 | 50 | virtual void poll(); |
| mbed714 | 0:98aadd37a5c5 | 51 | |
| mbed714 | 0:98aadd37a5c5 | 52 | static void servicesPoll(); //Poll all registered services & destroy closed ones |
| mbed714 | 0:98aadd37a5c5 | 53 | |
| mbed714 | 0:98aadd37a5c5 | 54 | protected: |
| mbed714 | 0:98aadd37a5c5 | 55 | ///This flags the service as to be destructed if owned by the pool. |
| mbed714 | 0:98aadd37a5c5 | 56 | void close(); |
| mbed714 | 0:98aadd37a5c5 | 57 | |
| mbed714 | 0:98aadd37a5c5 | 58 | private: |
| mbed714 | 0:98aadd37a5c5 | 59 | bool m_closed; |
| mbed714 | 0:98aadd37a5c5 | 60 | bool m_removed; |
| mbed714 | 0:98aadd37a5c5 | 61 | bool m_owned; |
| mbed714 | 0:98aadd37a5c5 | 62 | |
| mbed714 | 0:98aadd37a5c5 | 63 | static list<NetService*>& lpServices(); //Helper to prevent static initialization fiasco |
| mbed714 | 0:98aadd37a5c5 | 64 | |
| mbed714 | 0:98aadd37a5c5 | 65 | }; |
| mbed714 | 0:98aadd37a5c5 | 66 | |
| mbed714 | 0:98aadd37a5c5 | 67 | #endif |