recordstream-gw.h

Go to the documentation of this file.

// OSB library ********************************************* -*- C++ -*-
/*
  AUTHOR(S): Manikandan (mk)

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.27 $

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

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

// + local headers
#include "recordstream.h"

// *********************************************************************
// namespace extensions
namespace OSB_LIB {
    class RecordStreams;
    class RecordStreamFilter;
}

namespace OSB_DB {
    class Session;
}

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

// *********************************************************************
// class definitions
    struct RecordSourceGw {
    public:
        bool fetchById(
            const Session&               session,
                  OSB_LIB::RecordSource& rs
        );

        bool fetchByFormat(
            const Session&               session,
                  OSB_LIB::RecordSource& rs
        );

        long fetch(
            const Session&                session,
                  OSB_LIB::RecordSources& dest,
                  OSB_LIB::ModuleId       generator = OSB_LIB::mdAll
        );
    };

    struct RecordStreamGw {
        friend class OSB_LIB::RecordStreamInfo;
    public:
        bool fetch(
            const Session&                        session,
                  OSB_LIB::RecordStreamInfo&      rs
        );

        void fetchFiltered(
            const Session&                     session,
                  OSB_LIB::RecordStreams&      dest,
            const OSB_LIB::RecordStreamFilter& filter
        );

        void fetchOthers(
            const Session&                session,
                  OSB_LIB::RecordStreams& dest
        );

        bool getNext(
            const OSB_DB::Session&              session,
                  OSB_LIB::RecordStreamInfo&    dest,
                  OSB_LIB::ModuleId             processor,
                  OSB_LIB::RecordStream::Status status
        );

        bool getNext(
            const OSB_DB::Session&              session,
                  OSB_LIB::RecordStreamInfo&    dest,
                  OSB_LIB::ModuleId             processor,
            const OSB_LIB::RecordSource::Oid&   srcId,
                  OSB_LIB::RecordStream::Status status
        );

        bool getNext(
            const OSB_DB::Session&              session,
                  OSB_LIB::RecordStreamInfo&    dest,
            const std::string&                  format,
                  OSB_LIB::ModuleId             processor,
                  OSB_LIB::RecordStream::Status status
        );

    private:
        bool insert(
            const Session&                   session,
                  OSB_LIB::RecordStreamInfo& rs
        );

        bool update(
            const Session&                   session,
                  OSB_LIB::RecordStreamInfo& rs
        );

        bool remove(
            const Session&                   session,
                  OSB_LIB::RecordStreamInfo& rs
        );

        bool setProcessing(
            const Session&                        session,
            const OSB_LIB::RecordStreamInfo::Oid& rsId
        );

        bool setStatus(
            const Session&                      session,
            const OSB_LIB::RecordStreamInfo&    rs,
                  OSB_LIB::RecordStream::Status status
        );

        OSB_LIB::ObjectStatus checkObjVs(
            const Session&                   session,
            const OSB_LIB::RecordStreamInfo& rs
        );

        OSB_LIB::ObjectStatus lock(
            const Session&                   session,
                  OSB_LIB::RecordStreamInfo& rs
        );
    };
}                                       // namespace OSB_DB
#endif                                  // #ifndef _RECORDSTREAMGW_H_

---