ResourcePoolStats.hh

00001 //********************************************************************
00002 //*** ResourcePool/ResourcePoolStats.hh
00003 //*** Copyright (c) 2003-2009 by Markus Winand <mws@fatalmind.com>
00004 //*** $Id: ResourcePoolStats.hh,v 1.4 2009-03-02 14:16:44 mws Exp $
00005 //********************************************************************
00006 /*
00007 This file is part of ResourcePool.
00008 
00009 ResourcePool is free software; you can redistribute it
00010 and/or modify it under the terms of the GNU General Public License
00011 as published by the Free Software Foundation; either version 2 of
00012 the License, or (at your option) any later version.
00013 
00014 ResourcePool is distributed in the hope that it will be
00015 useful, but WITHOUT ANY WARRANTY; without even the implied warranty
00016 of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00017 GNU General Public License for more details.
00018 
00019 You should have received a copy of the GNU General Public License
00020 along with ResourcePool; if not, write to the Free Software
00021 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
00022 02111-1307  USA */
00023 
00024 #ifndef RESOURCEPOOL_RESOURCEPOOLSTATS_HH
00025 #define RESOURCEPOOL_RESOURCEPOOLSTATS_HH
00026 
00027 #include <ostream>
00028 
00029 namespace fatalmind {
00030 
00031 class ResourcePoolStats {
00032     public:
00033         ResourcePoolStats();
00034         ResourcePoolStats(const ResourcePoolStats& rho, int usedSize, int freeSize);
00035         ~ResourcePoolStats();
00036 
00037         unsigned long int getCalls() const;
00038         unsigned long int waitEvents() const;
00039         unsigned long int failCalls() const;
00040         int usedSize() const;
00041         int freeSize() const;
00042         float waitRatio() const;
00043         float failRatio() const;
00044 
00064         ResourcePoolStats& operator-=(const ResourcePoolStats&);
00069         ResourcePoolStats& operator+=(const ResourcePoolStats&);
00070 
00071         // those methods are public so that ResourcePool<XX> can access
00072         // but undocumented since it is not inteded for everybody's use.
00073         void getCall_(); 
00074         void waitEvent_();
00075         void failCall_();
00076 
00077     private:
00078         unsigned long int getCalls_;
00079         unsigned long int waitEvents_;
00080         unsigned long int failCalls_;
00081         int usedSize_;
00082         int freeSize_;
00083 };
00084 
00085 
00086 } // namespace fatalmind
00087 
00088 std::ostream& operator<<(std::ostream& os, const fatalmind::ResourcePoolStats& stats);
00089 
00090 #endif

Generated on Mon Nov 9 16:21:24 2009 for ResourcePool by  doxygen 1.5.3