lib/libUPnP/Neptune/Source/Core/NptInterfaces.h

   1 /*****************************************************************
   2 |
   3 |   Neptune - Interfaces
   4 |
   5 | Copyright (c) 2002-2008, Axiomatic Systems, LLC.
   6 | All rights reserved.
   7 |
   8 | Redistribution and use in source and binary forms, with or without
   9 | modification, are permitted provided that the following conditions are met:
  10 |     * Redistributions of source code must retain the above copyright
  11 |       notice, this list of conditions and the following disclaimer.
  12 |     * Redistributions in binary form must reproduce the above copyright
  13 |       notice, this list of conditions and the following disclaimer in the
  14 |       documentation and/or other materials provided with the distribution.
  15 |     * Neither the name of Axiomatic Systems nor the
  16 |       names of its contributors may be used to endorse or promote products
  17 |       derived from this software without specific prior written permission.
  18 |
  19 | THIS SOFTWARE IS PROVIDED BY AXIOMATIC SYSTEMS ''AS IS'' AND ANY
  20 | EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  21 | WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  22 | DISCLAIMED. IN NO EVENT SHALL AXIOMATIC SYSTEMS BE LIABLE FOR ANY
  23 | DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  24 | (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  25 | LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  26 | ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27 | (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  28 | SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29 |
  30  ****************************************************************/
  31
  32 #ifndef _NPT_INTERFACES_H_
  33 #define _NPT_INTERFACES_H_
  34
  35 /*----------------------------------------------------------------------
  36 |   includes
  37 +---------------------------------------------------------------------*/
  38 #include "NptTypes.h"
  39 #include "NptCommon.h"
  40 #include "NptResults.h"
  41 #include "NptConfig.h"
  42
  43 /*----------------------------------------------------------------------
  44 |   constants
  45 +---------------------------------------------------------------------*/
  46 const int NPT_ERROR_NO_SUCH_INTERFACE = NPT_ERROR_BASE_INTERFACES - 0;
  47
  48 /*----------------------------------------------------------------------
  49 |   NPT_InterfaceId
  50 +---------------------------------------------------------------------*/
  51 class NPT_InterfaceId
  52 {
  53  public:
  54     // methods
  55     bool operator==(const NPT_InterfaceId& id) const {
  56         return ((id.m_Id == m_Id) && (id.m_Version == m_Version));
  57     }
  58
  59     // members
  60     unsigned long m_Id;
  61     unsigned long m_Version;
  62 };
  63
  64 /*----------------------------------------------------------------------
  65 |   NPT_Polymorphic
  66 +---------------------------------------------------------------------*/
  67 class NPT_Polymorphic
  68 {
  69 public:
  70     // destructor
  71     virtual ~NPT_Polymorphic() {}
  72
  73     // methods
  74     virtual NPT_Result GetInterface(const NPT_InterfaceId& id,
  75                                     NPT_Interface*&        iface) = 0;
  76 };
  77
  78 /*----------------------------------------------------------------------
  79 |   NPT_Interruptible
  80 +---------------------------------------------------------------------*/
  81 class NPT_Interruptible
  82 {
  83 public:
  84     // destructor
  85     virtual ~NPT_Interruptible() {}
  86
  87     // methods
  88     virtual NPT_Result Interrupt() = 0;
  89 };
  90
  91 /*----------------------------------------------------------------------
  92 |   NPT_Configurable
  93 +---------------------------------------------------------------------*/
  94 class NPT_Configurable
  95 {
  96 public:
  97     // destructor
  98     virtual ~NPT_Configurable() {}
  99
 100     // methods
 101     virtual NPT_Result SetProperty(const char* /*name*/,
 102                                    const char* /*value*/) {
 103         return NPT_ERROR_NO_SUCH_PROPERTY;
 104     }
 105     virtual NPT_Result SetProperty(const char* /*name*/,
 106                                    int         /*value*/) {
 107         return NPT_ERROR_NO_SUCH_PROPERTY;
 108     }
 109     virtual NPT_Result GetProperty(const char*        /*name*/,
 110                                    NPT_PropertyValue& /*value*/) {
 111         return NPT_ERROR_NO_SUCH_PROPERTY;
 112     }
 113 };
 114
 115 #endif // _NPT_INTERFACES_H_