RTSPCacheDir.h

Go to the documentation of this file.

/* Copyright (C) 2000 KOM/Darmstadt University of Technology
 *
 * You are allowed to use all other parts of the code under the following terms:
 *
 * For non-commercial use, code may be used in unmodified form provided
 * that this copyright notice and this permission notice appear in
 * supporting documentation.
 *
 * This software is provided "as is" and without any express or implied
 * warranties, including, without limitation, the implied warranty of
 * fitness for a particular purpose.
 *
 * The code may be subjected to the GNU General Public License, Version 2,
 * and re-distributed under the terms of this license.
 * As a special exception, permission is granted to link this code
 * with the Qt library and distribute executables, as long as you
 * follow the requirements of the GNU GPL in regard to all of the
 * software in the executable aside from Qt.
 *
 * Commercial use other than under the terms of the GNU General Public
 * License is allowed only after express negotiation of conditions
 * with the authors.
 */

#ifndef RTSP_CACHE_DIR_H
#define RTSP_CACHE_DIR_H

#include "mnstream.h"
#include "MNdictionary.h"
#include "MNString.h"
#include "MNMutex.h"

class SDPSessionDescription;

struct SMPTE_t
{
  int                 hours;
  int                 minutes;
  int                 seconds;
  int                 frames;
};

class CacheEntry
{
private:
  int                    _hits;
  int                    _misses;
  MNString               _LocalFile;
  SDPSessionDescription* _sdp;
  int                    nb_Tokens; 
  bool                   _is_completed;
  u_int64_t              _fileSize; 

  CacheEntry( const CacheEntry& );
  CacheEntry& operator= ( const CacheEntry& );


public:

  CacheEntry();
  CacheEntry( MNString&              file,
              SDPSessionDescription* SDP, 
              bool                   completed,
              u_int64_t              file_size ); 
  ~CacheEntry();

  SDPSessionDescription* getSDP() const;
  void getLocalFile( MNString& );

  void setSDP( SDPSessionDescription* SDP );
  void setLocalFile( const MNString& LocalFile );

  void setFileSize( u_int64_t file_size ); 
  const MNString& getLocalFile ( );

  void      releaseToken( );
  void      getToken( );
  void      cacheHit( );
  void      cacheMiss( );
  int       get_nb_Tokens( );
  u_int64_t getFileSize( ); 
  void      set_is_completed( bool is_completed );
  bool      get_is_completed( );
};

class CacheDictionary : public MNdictionary<MNString, CacheEntry*>
{
public:
   virtual int compare( MNString const& x, MNString const& y) const; 
};


class RTSPCacheDir 
{

private:
  long            _space; 
  CacheDictionary _EntryList;
  MNMutex         Mux;

  /* Only for debugging -- MZ */
  ofstream        FileLogger;

  RTSPCacheDir( const RTSPCacheDir& );           //forbidden
  RTSPCacheDir& operator= (const RTSPCacheDir&); //forbidden
  void remove_incomplete_files();


public:
  
  RTSPCacheDir ();
  ~RTSPCacheDir ();

  bool        isCached( const MNString& URI );

  CacheEntry* getEntry( const MNString& URI );
  
  CacheEntry* getEntryWithToken( const MNString& URI );

  CacheEntry* getEntryByFile( const MNString& filename );

  bool        releaseToken( const MNString& URI );

  bool        addEntry( const MNString& URI, const MNString& lpmoc, CacheEntry* Entry, bool save = true );

  bool        addEntry( const MNString& URI, 
                        const MNString& file, 
                        const MNString& lpmoc,  
                        SDPSessionDescription* SDP, 
                        bool save = true, long file_size = 0 );

  bool        delEntry( const MNString& URI );

  bool        setLocalFile( MNString file );

  bool        setSDP( const SDPSessionDescription& SDP );

  bool        setComplete( bool complete );

  bool        checkSpace( int32_t  bwidth,
                          int32_t  duration,
                          int64_t& file_size );

  void        setFileComplete( const char* filename, bool comp );  

  void        setSpaceBytes( u_int64_t space );  
 
  bool        removeFirstFile( ); 

  bool        removeFirstUnusedFile( );

  u_int64_t   getSpaceBytes( ) const;
};

#endif /* RTSP_CACHE_DIR_H */

---