ipgroup.idl

Go to the documentation of this file.

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

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.13.2.1 $

  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 IPGROUP_IDL
#define IPGROUP_IDL

// *********************************************************************
// included idl files
#include "ip4address.idl"

module corba {
    module res {

    enum Direction {
        dirUnknown,  
        dirIn,       
        dirOut       
    };

    struct AssignableIp4 {
        Ip4Address address;

        boolean inAvail;

        boolean outAvail;
    };

    typedef sequence<AssignableIp4> AssignableIp4Seq;

    struct AssignedIp4 {
        ResourceId ip4Id;

        Direction dir;

        common::DateTime from;

        common::DateTime to;
    };

    typedef sequence<AssignedIp4> AssignedIp4Seq;

    interface IpGroup : Resource
    {
        common::Utf8String desc()
            raises (common::OsbCorbaException);

        AssignedIp4Seq getIp4s()
            raises (common::OsbCorbaException);

        Ip4AddressSeq getCurIp4s()
            raises (common::OsbCorbaException);

        AssignedIp4Seq getCurAssIp4s()
            raises (common::OsbCorbaException);

        AssignableIp4Seq getAssignableIp4s()
            raises (common::OsbCorbaException);

        IpGroupWriter getWriter()
            raises (common::OsbCorbaException);
    };                          // interface IpGroup

    interface IpGroupWriter : ResourceWriter, IpGroup
    {
        void setDesc(in common::Utf8String desc);

        void addIp4(
            in ResourceId   id,
            in Direction    dir,
            in common::Date start,
            in boolean      noWait
        ) raises (common::OsbCorbaException);

        void delIp4(
            in ResourceId id,
            in Direction  dir,
            in boolean    noWait
        ) raises (common::OsbCorbaException);
    };                          // interface IpGroupWriter

    };                                  // module res
};                                      // module corba
#endif                                  // #ifndef IPGROUP_IDL

---