NewNet/nnratelimiter.h

00001 /*  NewNet - A networking framework in C++
00002     Copyright (C) 2006 Ingmar K. Steen (iksteen@gmail.com)
00003 
00004     This program is free software; you can redistribute it and/or modify
00005     it under the terms of the GNU General Public License as published by
00006     the Free Software Foundation; either version 2 of the License, or
00007     (at your option) any later version.
00008 
00009     This program is distributed in the hope that it will be useful,
00010     but WITHOUT ANY WARRANTY; without even the implied warranty of
00011     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00012     GNU General Public License for more details.
00013 
00014     You should have received a copy of the GNU General Public License
00015     along with this program; if not, write to the Free Software
00016     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00017 
00018  */
00019 
00020 #ifndef NEWNET_RATELIMITER_H
00021 #define NEWNET_RATELIMITER_H
00022 
00023 #include "nnobject.h"
00024 
00025 namespace NewNet
00026 {
00028 
00031   class RateLimiter : public Object
00032   {
00033   public:
00035 
00037     RateLimiter();
00038 
00039 #ifndef DOCYGEN_UNDOCUMENTED
00040     ~RateLimiter();
00041 #endif // DOXYGEN_UNDOCUMENTED
00042 
00044 
00047     ssize_t limit() const
00048     {
00049       return m_Limit;
00050     }
00051 
00053 
00056     void setLimit(ssize_t limit)
00057     {
00058       m_Limit = limit;
00059     }
00060 
00062 
00065     void transferred(ssize_t bytes);
00066 
00068 
00073     long nextWindow();
00074 
00075   private:
00076     /* Flush old data from the vector */
00077     void flush();
00078 
00079     ssize_t m_Limit;
00080 
00081 #ifndef DOXYGEN_UNDOCUMENTED
00082     // The collection data depends on platform specific types, hide it
00083     struct Data;
00084     struct Data * m_Data;
00085 #endif // DOXYGEN_UNDOCUMENTED
00086   };
00087 }
00088 
00089 #endif // NEWNET_RATELIMITER_H

Generated on Sun Jan 7 14:00:01 2007 for NewNet by  doxygen 1.5.1