ipaddress-gw.h

Go to the documentation of this file.

// OSB library ********************************************* -*- C++ -*-
/*
  AUTHOR(S): Lilian Qin Lan (lan)

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.19 $

  License
   OSB rating and billing library for communication networks
   Copyright (C) 2004, 2005, 2006  OSB systems

   This file may be distributed and/or modify under the terms of the
   GNU General Public License (GPL) as published by the Free Software
   Foundation which is provided in the file LICENSE.GPL included in the
   packaging of this file.

   The file is distributed in the hope that it will be useful, but WITHOUT
   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
   for more details.

   Holders of a OSB Commercial License may use this file under the terms
   and conditions of this commercial license.
 */
#ifndef _IPADDRESSGW_H_
#define _IPADDRESSGW_H_

// *********************************************************************
// included header files
// + standard includes
#include <utility>

// + local headers
#include "ipaddress.h"
#include "resourcefwd.h"

// *********************************************************************
// class declarations
namespace OSB_LIB {
    template<typename I> class Id;
    class Ip4Address;
    class IpGroup;
}

namespace OSB_DB {
    class Session;
}

// ************************************************************************
// namespace extensions
namespace OSB_DB {

// *********************************************************************
// class definitions

    // *****************************************************************
    // class Ip4AddressGw
    class Ip4AddressGw {
        friend class OSB_LIB::Ip4Address;
        friend class OSB_DB::IpGroupGw;
        typedef OSB_LIB::ResourceList<OSB_LIB::Ip4Address> Ip4List;
        typedef OSB_LIB::Id<OSB_LIB::Network> NwOid;
    public:
        void fetch(
            const Session& session,
                  Ip4List& dest,
            const NwOid&   nwId,
                  bool     availOnly
        );

        void fetch(
            const Session&                 session,
                  OSB_LIB::AssignableIp4s& dest
        );

    private:
        bool read(
            const Session&             session,
                  OSB_LIB::Ip4Address& ip4
        ) const;

        bool insert(
            const Session&             session,
            const OSB_LIB::Ip4Address& ip4
        ) const;

        bool update(
            const Session&             session,
            const OSB_LIB::Ip4Address& ip4
        ) const;

        bool remove(
            const Session&             session,
            const OSB_LIB::Ip4Address& ip4
        ) const;
    };

    // *****************************************************************
    // class IpGroupGw
    class IpGroupGw {
        friend class OSB_LIB::IpGroup;
        typedef
        OSB_LIB::ResourceList<OSB_LIB::IpGroup> IpGroupList;
        typedef OSB_LIB::Id<OSB_LIB::Network> NwOid;
    public:
        void fetch(
            const Session&     session,
                  IpGroupList& dest,
            const NwOid&       nwId,
                  bool         availOnly
        );

    private:
        bool read(
            const Session&          session,
                  OSB_LIB::IpGroup& ipg
        ) const;

        bool insert(
            const Session&          session,
            const OSB_LIB::IpGroup& ipg
        ) const;

        bool update(
            const Session&          session,
            const OSB_LIB::IpGroup& ipg
        ) const;

        bool remove(
            const Session&          session,
            const OSB_LIB::IpGroup& ipg
        ) const;

        std::pair<bool, bool> getCurIp4Assignments(
            const Session&                  session,
            const OSB_LIB::Ip4Address::Oid& ip4Id
        ) const;

        bool insIp4(
            const Session&                       session,
            const OSB_LIB::IpGroup::Oid&         ipgId,
            const OSB_LIB::IpGroup::AssignedIp4& assignedIp4
        ) const;

        bool updIp4(
            const Session&                  session,
            const OSB_LIB::IpGroup::Oid&    ipgId,
            const OSB_LIB::Ip4Address::Oid& ip4Id,
            OSB_LIB::IpGroup::Direction     dir
        ) const;

    };


// *********************************************************************
// inline definitions
}
#endif                                  // #ifndef _IPADDRESSGW_H_

---