nodes/streaming/medialayernode/include/pvmf_ml_eos_timer.h

/* ------------------------------------------------------------------
 * Copyright (C) 2008 PacketVideo
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 * -------------------------------------------------------------------
 */
#ifndef PVMF_ML_EOS_TIMER_H_INCLUDED
#define PVMF_ML_EOS_TIMER_H_INCLUDED

#ifndef OSCL_BASE_H_INCLUDED
#include "oscl_base.h"
#endif
#ifndef PVLOGGER_H_INCLUDED
#include "pvlogger.h"
#endif
#ifndef OSCL_SCHEDULER_AO_H_INCLUDED
#include "oscl_scheduler_ao.h"
#endif
#ifndef PVMF_RETURN_CODES_H_INCLUDED
#include "pvmf_return_codes.h"
#endif

/**
 * Observer class for the EOS timer AO
 */
class PvmfEOSTimerObserver
{
    public:
        /**
         * A timer event, indicating that the EOS timer has expired.
         */
        virtual void EOSTimerEvent() = 0;
};

/**
 * RTCP timer object to Jitter Buffer node. This object generates events at
 * specified RTCP time intervals
 */
class PvmfEOSTimer : public OsclTimerObject
{
    public:
        OSCL_IMPORT_REF PvmfEOSTimer(PvmfEOSTimerObserver* aObserver);

        OSCL_IMPORT_REF virtual ~PvmfEOSTimer();

        /** Start EOS Timer */
        OSCL_IMPORT_REF PVMFStatus Start();

        OSCL_IMPORT_REF PVMFStatus setSessionDuration(uint32 sessionDurationInMS);

        /** Stop Timer events */
        OSCL_IMPORT_REF PVMFStatus Stop();

        bool IsTimerStarted()
        {
            return iStarted;
        }

    private:
        void Run();

        uint32 iSessionDurationInMS;
        PvmfEOSTimerObserver* iObserver;
        PVLogger* iLogger;
        bool iStarted;
};
#endif // PVMF_JB_EOS_TIMER_H_INCLUDED