// Copyright (C) 2001-2015 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 Lesser General Public License
// along with GNU ccRTP.  If not, see <http://www.gnu.org/licenses/>.
//
// 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.
//

/**
 * @file pool.h
 * @short Pools of RTP sessions.
 **/

#ifndef CCXX_RTP_POOL_H
#define CCXX_RTP_POOL_H

#include <list>
#include <ccrtp/rtp.h>

NAMESPACE_COMMONCPP
using std::list;

typedef TRTPSessionBase<> RTPSessionBase;

class RTPSessionBaseHandler
{
public:
    inline microtimeout_t getSchedulingTimeout(RTPSessionBase& s)
    { return s.getSchedulingTimeout(); }

    inline timeval getRTCPCheckInterval(RTPSessionBase& s)
    { return s.getRTCPCheckInterval(); }

    size_t
    takeInDataPacket(RTPSessionBase& s)
    { return s.takeInDataPacket(); }

    size_t
    dispatchDataPacket(RTPSessionBase& s)
    { return s.dispatchDataPacket(); }

    void
    controlReceptionService(RTPSessionBase& s)
    { s.controlReceptionService(); }

    void
    controlTransmissionService(RTPSessionBase& s)
    { s.controlTransmissionService(); }

    inline SOCKET getDataRecvSocket(RTPSessionBase& s) const
    { return s.getDataRecvSocket(); }

    inline SOCKET getControlRecvSocket(RTPSessionBase& s) const
    { return s.getControlRecvSocket(); }
};

/**
 * Class for tracking session status. Session pools arrange sessions
 * in lists of SessionListElement objects.
 *
 * @author Jorgen Terner
 **/

class SessionListElement {
private:
    RTPSessionBase* elem;
    bool cleared;

public:
    SessionListElement(RTPSessionBase* e);
    void clear();
    bool isCleared();
    RTPSessionBase* get();
};


inline SessionListElement::SessionListElement(RTPSessionBase* e)
    : elem(e), cleared(false) {
}

inline void SessionListElement::clear() {
    cleared = true;
    delete elem;
    elem = 0;
}

inline bool SessionListElement::isCleared() {
    return cleared;
}

inline RTPSessionBase* SessionListElement::get() {
    return elem;
}

/**
 * std equality for SessionListElement objects.
 *
 * @author Jorgen Terner
 **/
class PredEquals
{
protected:
    RTPSessionBase* elem;
public:
    PredEquals(RTPSessionBase* e) : elem(e) {}

    bool operator() (SessionListElement* e)
    {
        return e->get() == elem;
    }
};

/**
 * This class is a base class for classes that define a group of RTP
 * sessions that will be served by one or more execution
 * threads. Derived classes are responsible for serving each RTP
 * session with a thread at least.
 *
 * In order to use the RTP session "pool" you just have to build
 * RTPSessionBase objects for each RTP session (instead of RTPSession
 * objects). Then, add the RTPSessionBase objects to an RTP session
 * "pool" and call startRunning() method of the session pool.
 *
 * @author Federico Montesino Pouzols <fedemp@altern.org>
 **/
class __EXPORT RTPSessionPool: public RTPSessionBaseHandler
{
public:
    RTPSessionPool();

    inline virtual ~RTPSessionPool()
    { }

    bool
    addSession(RTPSessionBase& session);

    bool
    removeSession(RTPSessionBase& session);

    size_t
    getPoolLength() const;

    virtual void startRunning() = 0;

    inline bool isActive()
    { return poolActive; }

protected:
    inline void setActive()
    { poolActive = true; }

    inline timeval getPoolTimeout()
    { return poolTimeout; }

    inline void setPoolTimeout(int sec, int usec)
    { poolTimeout.tv_sec = sec; poolTimeout.tv_usec = usec; }

    inline void setPoolTimeout(struct timeval to)
    { poolTimeout = to; }

    std::list<SessionListElement*> sessionList;
    typedef std::list<SessionListElement*>::iterator PoolIterator;

    mutable ThreadLock poolLock;

#ifndef _MSWINDOWS_
    fd_set recvSocketSet;
    SOCKET highestSocket;  // highest socket number + 1
#endif

private:
    timeval poolTimeout;
    mutable bool poolActive;
};


class __EXPORT SingleRTPSessionPool :
        public RTPSessionPool,
        public Thread
{
public:
    /**
     * @param pri optional thread priority value.
     **/
    SingleRTPSessionPool(int pri = 0) :
        RTPSessionPool(),
        Thread(pri)
    { }

    ~SingleRTPSessionPool()
    { }

    void startRunning()
    { setActive(); Thread::start(); }

protected:
    /**
     * Runnable method for the thread. This thread serves all the
     * RTP sessions.added to this pool.
     */
    void run();
};

END_NAMESPACE

#endif //CCXX_RTP_POOL_H

/** EMACS **
 * Local variables:
 * mode: c++
 * c-basic-offset: 8
 * End:
 */
