ioqueue.h

Go to the documentation of this file.

// Copyright (C) 2001,2002,2004 Federico Montesino Pouzols <fedemp@altern.org>.
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// This program 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.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
//
// As a special exception, you may use this file as part of a free software
// library without restriction.  Specifically, if other files instantiate
// templates or use macros or inline functions from this file, or you compile
// this file and link it with other files to produce an executable, this
// file does not by itself cause the resulting executable to be covered by
// the GNU General Public License.  This exception does not however
// invalidate any other reasons why the executable file might be covered by
// the GNU General Public License.
//
// This exception applies only to the code released under the name GNU
// ccRTP.  If you copy code from other releases into a copy of GNU
// ccRTP, as the General Public License permits, the exception does
// not apply to the code that you add in this way.  To avoid misleading
// anyone as to the status of such modified files, you must delete
// this exception notice from them.
//
// If you write modifications of your own for GNU ccRTP, it is your choice
// whether to permit this exception to apply to your modifications.
// If you do not wish that, delete this exception notice.
//

#ifndef CCXX_RTP_IOQUEUE_H_
#define CCXX_RTP_IOQUEUE_H_

#include <ccrtp/iqueue.h>
#include <ccrtp/oqueue.h>

#ifdef  CCXX_NAMESPACES
namespace ost {
#endif

class __EXPORT RTPDataQueue :
        public IncomingDataQueue,
        public OutgoingDataQueue
{
public:
        typedef enum {
                tosBestEffort,      
                tosEnhanced         
        }       Tos;

        inline void
        setTypeOfService(Tos tos)
        { typeOfService = tos; }

        inline void enableStack()
        { dataServiceActive = true; }

        inline void disableStack()
        { dataServiceActive = false; }

        inline bool
        isActive() const
        { return dataServiceActive; }

        uint32
        getCurrentTimestamp() const;

        void
        setSessionBandwidth(uint32 bw)
        { sessionBw = bw; }

        uint32
        getDefaultSessionBandwidth() const
        { return defaultSessionBw; }

        uint32
        getSessionBandwidth() const
        { return sessionBw; }

        inline void
        setTimeclock()
        { timeclock.setTimer(); }

        inline timeout_t
        getTimeclock() const
        { return timeclock.getElapsed(); }

protected:

        RTPDataQueue(uint32 size = defaultMembersHashSize);

        RTPDataQueue(uint32* ssrc, uint32 size = defaultMembersHashSize);

        inline virtual
        ~RTPDataQueue()
        { endQueue(); }

        inline virtual void
        timerTick()
        { return; }

        void renewLocalSSRC()
                {IncomingDataQueue::renewLocalSSRC();}

private:
        RTPDataQueue(const RTPDataQueue &o);

        RTPDataQueue&
        operator=(const RTPDataQueue &o);

        void
        initQueue();

protected:
        void
        endQueue();

        virtual bool
        isPendingData(microtimeout_t timeout) = 0;

private:
        // true if connection "active"
        volatile bool dataServiceActive;
        Tos typeOfService;
        TimerPort timeclock;
        /* RTP session bandwidth control */
        static const uint32 defaultSessionBw;
        uint32 sessionBw;


};
 // ioqueue

#ifdef  CCXX_NAMESPACES
}
#endif

#endif  //CCXX_RTP_IOQUEUE_H_