netservice.h

00001 
00002 /*
00003 Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com)
00004  
00005 Permission is hereby granted, free of charge, to any person obtaining a copy
00006 of this software and associated documentation files (the "Software"), to deal
00007 in the Software without restriction, including without limitation the rights
00008 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00009 copies of the Software, and to permit persons to whom the Software is
00010 furnished to do so, subject to the following conditions:
00011  
00012 The above copyright notice and this permission notice shall be included in
00013 all copies or substantial portions of the Software.
00014  
00015 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00016 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00017 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00018 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00019 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00020 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
00021 THE SOFTWARE.
00022 */
00023 
00024 /**
00025 \file Net Service base class header file
00026 */
00027 
00028 #ifndef NETSERVICE_H
00029 #define NETSERVICE_H
00030 
00031 #include <list>
00032 using std::list;
00033 
00034 ///Net Service base class
00035 /**
00036 Each connection-oriented object can register as service (by inheriting this class), so that it is polled regularly.
00037 It notifies the pool when the connection is terminated so that it can be destroyed.
00038 */
00039 class NetService
00040 {
00041 public:
00042   ///Instantiates a new service
00043   /**
00044   @param owned If true the object is owned by the pool and will be destroyed on closure.
00045   */
00046   NetService(bool owned = true); //Is owned by the pool?
00047   virtual ~NetService();
00048 
00049   ///This method can be inherited so that it is called on each @a Net::poll() call.
00050   virtual void poll();
00051  
00052   static void servicesPoll(); //Poll all registered services & destroy closed ones
00053 
00054 protected:
00055   ///This flags the service as to be destructed if owned by the pool.
00056   void close();
00057   
00058 private:
00059   bool m_closed;
00060   bool m_removed;
00061   bool m_owned;
00062   
00063   static list<NetService*>& lpServices(); //Helper to prevent static initialization fiasco  
00064 
00065 };
00066 
00067 #endif