cdrstorage.h

Go to the documentation of this file.

// OSB library ************************************************ -*- C++ -*-
/*
  AUTHOR(S): Stephan Broennimann (vb)

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.13 $

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

// ************************************************************************
// included header files
// + standard includes

// + libraries

// + local headers
#include "osberror.h"
#include "osbid.h"

// + class declarations
namespace OSB_LIB {
    class Cdr;
    class CdrList;
    class RecordStreamInfo;
}

namespace OSB_DB {
    class Session;
}

// ************************************************************************
// namespace extensions
namespace OSB_LIB {

// ************************************************************************
// forward declarations

// ************************************************************************
// type definitions

// ************************************************************************
// class definitions
    class CdrStorage {
    public:
        // exception thrown if a previous batch was not finalized
        class StreamPending;
    public:
        CdrStorage();
        virtual ~CdrStorage();
    protected:

        CdrStorage(const CdrStorage&);
        CdrStorage& operator=(const CdrStorage&);

    public:
        virtual OsbError beginStream(
            const OSB_DB::Session&  session,
            const RecordStreamInfo& input
        ) = 0;

        virtual bool push(
            const Cdr&      cdr,
                  OsbError& error
        ) = 0;

        virtual OsbError prepareWrite(
            OSB_DB::Session& session
        ) = 0;

        virtual OsbError writeCdrFiles() = 0;

        virtual OsbError storeCdrs(
            const OSB_DB::Session& session,
                  CdrList&         errors
        ) = 0;

        virtual OsbError endStream() = 0;

        virtual bool undoChanges(
            OSB_DB::Session& session
        ) = 0;
    };                                  // class CdrStorage

    class CdrStorage::StreamPending : public OsbException {
    public:
        static const ErrorNo errno_ = 801;
        StreamPending(const Id<RecordStreamInfo>& rsId);
    };                                  // class CdrStorage::StreamPending
}                                       // namespace OSB_LIB

// ************************************************************************
// inline definitions
namespace OSB_LIB {
}                                       // namespace OSB_LIB
#endif                                  // #ifndef _CDRSTORAGE_H_

---