lib/libUPnP/Platinum/Source/Core/PltConstants.h

   1 /*****************************************************************
   2 |
   3 |   Platinum - UPnP Constants
   4 |
   5 | Copyright (c) 2004-2010, Plutinosoft, LLC.
   6 | All rights reserved.
   7 | http://www.plutinosoft.com
   8 |
   9 | This program is free software; you can redistribute it and/or
  10 | modify it under the terms of the GNU General Public License
  11 | as published by the Free Software Foundation; either version 2
  12 | of the License, or (at your option) any later version.
  13 |
  14 | OEMs, ISVs, VARs and other distributors that combine and
  15 | distribute commercially licensed software with Platinum software
  16 | and do not wish to distribute the source code for the commercially
  17 | licensed software under version 2, or (at your option) any later
  18 | version, of the GNU General Public License (the "GPL") must enter
  19 | into a commercial license agreement with Plutinosoft, LLC.
  20 | licensing@plutinosoft.com
  21 |
  22 | This program is distributed in the hope that it will be useful,
  23 | but WITHOUT ANY WARRANTY; without even the implied warranty of
  24 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25 | GNU General Public License for more details.
  26 |
  27 | You should have received a copy of the GNU General Public License
  28 | along with this program; see the file LICENSE.txt. If not, write to
  29 | the Free Software Foundation, Inc.,
  30 | 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  31 | http://www.gnu.org/licenses/gpl-2.0.html
  32 |
  33 ****************************************************************/
  34
  35 /** @file
  36  UPnP Constants
  37  */
  38
  39 #ifndef _PLT_UPNP_CONSTANTS_H_
  40 #define _PLT_UPNP_CONSTANTS_H_
  41
  42 /*----------------------------------------------------------------------
  43 |   includes
  44 +---------------------------------------------------------------------*/
  45 #include "Neptune.h"
  46
  47 /*----------------------------------------------------------------------
  48 |   PLT_Constants
  49 +---------------------------------------------------------------------*/
  50 /**
  51  The PLT_Constants class provides a way to globally set or get certain
  52  UPnP constants.
  53  */
  54 class PLT_Constants
  55 {
  56 public:
  57     // class methods
  58     static PLT_Constants& GetInstance();
  59
  60     PLT_Constants();
  61     ~PLT_Constants() {};
  62
  63     void SetDefaultDeviceLease(NPT_TimeInterval lease) { m_DefaultDeviceLease = new NPT_TimeInterval(lease); }
  64     NPT_Reference<NPT_TimeInterval> GetDefaultDeviceLease() { return m_DefaultDeviceLease; }
  65
  66     void SetDefaultSubscribeLease(NPT_TimeInterval lease) { m_DefaultSubscribeLease = new NPT_TimeInterval(lease); }
  67     NPT_Reference<NPT_TimeInterval> GetDefaultSubscribeLease() { return m_DefaultSubscribeLease; }
  68
  69     void SetDefaultUserAgent(const char* agent) { m_DefaultUserAgent = new NPT_String(agent); }
  70     NPT_Reference<NPT_String> GetDefaultUserAgent() { return m_DefaultUserAgent; }
  71
  72     void SetSearchMulticastTimeToLive(NPT_UInt32 ttl) { m_SearchMulticastTimeToLive = ttl; }
  73     NPT_UInt32 GetSearchMulticastTimeToLive() { return m_SearchMulticastTimeToLive; }
  74
  75     void SetAnnounceMulticastTimeToLive(NPT_UInt32 ttl) { m_AnnounceMulticastTimeToLive = ttl; }
  76     NPT_UInt32 GetAnnounceMulticastTimeToLive() { return m_AnnounceMulticastTimeToLive; }
  77
  78 private:
  79     // members
  80     NPT_Reference<NPT_TimeInterval> m_DefaultDeviceLease;
  81     NPT_Reference<NPT_TimeInterval> m_DefaultSubscribeLease;
  82     NPT_Reference<NPT_String>       m_DefaultUserAgent;
  83     NPT_UInt32                      m_SearchMulticastTimeToLive;
  84     NPT_UInt32                      m_AnnounceMulticastTimeToLive;
  85 };
  86
  87 #endif /* _PLT_UPNP_CONSTANTS_H_ */