StreamHttpDataSource.h

Go to the documentation of this file.

//  
// Copyright (C) 2006 SIPez LLC. 
// Licensed to SIPfoundry under a Contributor Agreement. 
//
// Copyright (C) 2004-2006 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2004-2006 Pingtel Corp.  All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// $$

#ifndef DISABLE_STREAM_PLAYER // [

#ifndef _StreamHttpDataSource_h_
#define _StreamHttpDataSource_h_

// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include "mp/StreamDataSource.h"
#include "net/Url.h"
#include "os/OsDefs.h"
#include "os/OsStatus.h"
#include "os/OsTask.h"
#include "os/OsBSem.h"


// DEFINES
#define DEFAULT_BUFFER_SIZE   128*1024
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// FORWARD DECLARATIONS
class OsConnectionSocket ;
class HttpMessage ;
// TYPEDEFS
typedef UtlBoolean (*GetDataCallbackProc)(char* pData, 
                                         int iLength, 
                                         void* pOptionalData, 
                                         HttpMessage* pMsg);



class StreamHttpDataSource : public StreamDataSource, public OsTask
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

/* ============================ CREATORS ================================== */

   StreamHttpDataSource(Url url, int iFlags);

   virtual ~StreamHttpDataSource();


/* ============================ MANIPULATORS ============================== */

   virtual OsStatus open() ;

   virtual OsStatus close() ;

   virtual OsStatus destroyAndDelete() ;

   virtual OsStatus read(char *szBuffer, int iLength, int& iLengthRead) ;
   virtual OsStatus peek(char* szBuffer, int iLength, int& iLengthRead) ;
   virtual OsStatus interrupt() ;
   virtual OsStatus seek(unsigned int iLocation);
   UtlBoolean deliverData(char *szData, int iLength, int iMaxLength) ;


/* ============================ ACCESSORS ================================= */


   virtual OsStatus getLength(int& iLength);      

   virtual OsStatus getPosition(int& iPosition) ;

   virtual OsStatus toString(UtlString& string) ;
     // This is often used for debugging purposes.

   virtual int getBufferedLength();


/* ============================ INQUIRY =================================== */



/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:

   StreamHttpDataSource(const StreamHttpDataSource& rStreamHttpDataSource);

   StreamHttpDataSource& operator=(const StreamHttpDataSource& rhs);

   int run(void *pArgs);

/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
   Url        m_url ;                  
   UtlString  mBuffer ;                
   OsBSem     mSemNeedData ;           
   OsBSem     mSemLimitData ;          
   OsBSem     mSemGuardData;           
   OsBSem     mSemGuardStartClose;     
   UtlBoolean  mbDone ;                
   UtlBoolean  mbQuit ;                
   UtlBoolean  mbDeleteOnCompletion ;  
   unsigned int  miMaxData ;           
   unsigned int  miDSLength ;          
   unsigned int  miOffset ;            
   unsigned int  miBufferOffset ;      
   UtlBoolean  mbFiredThrottledEvent ; 
   UtlBoolean  mbClosed ;              
   UtlBoolean  mbInterrupt ;           

   static OsBSem sSemGuardDelete;      
};

/* ============================ INLINE METHODS ============================ */

#endif  // _StreamHttpDataSource_h_

#endif // DISABLE_STREAM_PLAYER ]