StreamDataSource.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 _StreamDataSource_h_
#define _StreamDataSource_h_

// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include <utl/UtlString.h>
#include "mp/StreamDefs.h"
#include "os/OsStatus.h"
// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS

typedef enum                  // Data source event definitions
{
   LoadingStartedEvent,       // Data source statred loading
   LoadingThrottledEvent,     // Data source throttled
   LoadingCompletedEvent,     // Data source completed loading
   LoadingErrorEvent          // Data source error

} StreamDataSourceEvent;

// FORWARD DECLARATIONS
class StreamDataSourceListener;


class StreamDataSource
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

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


   StreamDataSource(int iFlags = 0);
   virtual ~StreamDataSource();


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


   virtual OsStatus open() = 0 ;

   virtual OsStatus close() = 0 ;

   virtual OsStatus destroyAndDelete() = 0 ;

   virtual OsStatus read(char *szBuffer, int iLength, int& iLengthRead) = 0;
   virtual OsStatus peek(char* szBuffer, int iLength, int& iLengthRead) = 0;
   virtual OsStatus interrupt() ;
   virtual OsStatus seek(unsigned int iLocation) = 0 ;
   void setListener(StreamDataSourceListener* pListener);
   

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


   virtual OsStatus getLength(int& iLength) = 0 ;

   virtual OsStatus getPosition(int& iPosition) = 0 ;

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


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



/* ============================ TESTING =================================== */

#ifdef MP_STREAM_DEBUG /* [ */
static const char* getEventString(StreamDataSourceEvent event);
#endif /* MP_STREAM_DEBUG ] */

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

   StreamDataSource(const StreamDataSource& rStreamDataSource);

   StreamDataSource& operator=(const StreamDataSource& rhs);

   void fireEvent(StreamDataSourceEvent event);


/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
   StreamDataSourceListener* mpListener; 
   int                       miFlags;    
};

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

#endif  // _StreamDataSource_h_