delaychan.h

Go to the documentation of this file.

/*
 * delaychan.h
 *
 * Class for implementing a serial queue channel in memory.
 *
 * Portable Windows Library
 *
 * Copyright (c) 2001 Equivalence Pty. Ltd.
 *
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.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.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 *
 * The Original Code is Portable Windows Library.
 *
 * The Initial Developer of the Original Code is Equivalence Pty. Ltd.
 *
 * Contributor(s): ______________________________________.
 */

#ifndef PTLIB_DELAYCHAN_H
#define PTLIB_DELAYCHAN_H
#include <ptlib/contain.h>
#include <ptlib/object.h>
#include <ptlib/timeint.h>
#include <ptlib/ptime.h>
#include <ptlib/indchan.h>

#ifdef P_USE_PRAGMA
#pragma interface
#endif


class PAdaptiveDelay : public PObject
{ 
  PCLASSINFO(PAdaptiveDelay, PObject);
  
  public:

    PAdaptiveDelay(
      const PTimeInterval & maximumSlip = 0,   
      const PTimeInterval & minimumDelay = 0   
    );

    void SetMaximumSlip(const PTimeInterval & maximumSlip)
    { m_maximumSlip = -maximumSlip; }

    PTimeInterval GetMaximumSlip() const
    { return -m_maximumSlip; }

    const PTimeInterval & GetActualDelay() const { return m_actualDelay; }

    enum DelayResult
    {
        eOnTime,    
        eOverSlept, 
        eLate,      
        eSlipped,   
        eBadDelta   
    };

    DelayResult Delay(int deltaMS) { return DelayInterval(deltaMS); }

    DelayResult DelayInterval(const PTimeInterval & delta);

    void Restart();
 
  protected:
    PTimeInterval  m_maximumSlip;
    PTimeInterval  m_minimumDelay;
    PTimeInterval  m_actualDelay;
    PTime          m_targetTime;
    bool           m_firstTime;
#if PTRACING
    unsigned m_traceLevel;
#endif
};


class PDelayChannel : public PIndirectChannel
{
    PCLASSINFO(PDelayChannel, PIndirectChannel);
  public:
    enum Mode {
      DelayReadsOnly,
      DelayWritesOnly,
      DelayReadsAndWrites
    };

    PDelayChannel(
      Mode mode,                  
      unsigned frameDelay,        
      PINDEX frameSize = 0,       
      unsigned maximumSlip = 250, 
      unsigned minimumDelay = 10  
    );
    
    PDelayChannel(
        PChannel &channel,          
        Mode mode,                  
        unsigned frameDelay,        
        PINDEX frameSize = 0,       
        unsigned maximumSlip = 250, 
        unsigned minimumDelay = 10  
                 );    


    virtual PBoolean Read(
      void * buf,   
      PINDEX len    
    );

    virtual PBoolean Write(
      const void * buf, 
      PINDEX len        
    );


  protected:
    virtual void Wait(PINDEX count, PTimeInterval & nextTick);

    Mode          mode;
    unsigned      frameDelay;
    PINDEX        frameSize;
    PTimeInterval maximumSlip;
    PTimeInterval minimumDelay;

    PTimeInterval nextReadTick;
    PTimeInterval nextWriteTick;
};


#endif // PTLIB_DELAYCHAN_H


// End Of File ///////////////////////////////////////////////////////////////