CascadeHTTPStream.h

Go to the documentation of this file.

//
// CascadeHTTPStream.h - header file for class CascadeHTTPStream
//
// Copyright (c) 2002, Roku, LLC.  All rights reserved.
//

#ifndef _ROKU_INCLUDE_CASCADE_AV_CASCADEHTTPSTREAM_H
#define _ROKU_INCLUDE_CASCADE_AV_CASCADEHTTPSTREAM_H

#include <cascade/util/CascadeStream.h>

class CascadeHTTPClient;
class CascadeHTTPStream;

class CascadeHTTPStream : public CascadeStream
{
public:
        CascadeHTTPStream();
        CascadeHTTPStream(const char * pURL);
        virtual ~CascadeHTTPStream();
public:
    virtual bool Open(const char * pURL);

    virtual bool Close();

            void SetConnectTimeout( u32 inMicroseconds );

            void SetSendTimeout( u32 inMicroseconds );

            void SetReceiveTimeout( u32 inMicroseconds );

            void SetUserAgent( const CascadeString &inUserAgentString );
            bool GetResponseHeaderValue( const char * pResponseHeaderKey, 
                                         CascadeString &value) const;


public: // overrides from class CascadeStream
    virtual  u64 GetSize();
    virtual  u64 GetPosition();
    virtual bool SeekToPosition(u64 nPosition);
    virtual  u32 ReadBytes(u32 nBytes, void * pBuff);
public:
    virtual bool ForceSeekToPosition(u64 nPosition);
        // this one forces the seek to the position, ignoring
        // the value of the current position
protected:
    virtual void AddHeaders( CascadeHTTPClient *inClient ) {}
        // For override by subclasses that may need to add additional
        // headers
    virtual void OnHTTPConnectionEstablished( CascadeHTTPClient *inClient ) {}
        // For override by subclasses that may need to read response
        // headers
private:
    class Stream; friend class Stream;
    Stream * m_pStream;
};

#endif // #ifndef _ROKU_INCLUDE_CASCADE_AV_CASCADEHTTPSTREAM_H

//  LOG
//  16-Mar-04   dave        created
//  17-May-04   dwoodward   modified
//  24-May-04   mjkobb      Added AddHeaders functionality
//  16-Jun-04   mjkobb      Added SetReceiveTimeout
//  27-Jun-04   mjkobb      Oops.  Added SetConnectTimeout and SetSendTimeout
//  15-Sep-04   mjkobb      Roll 1.1 changes into 1.2
//  07-Oct-04   dwoodward   added ForceSeekToPosition()
//      28-Oct-04       dsletten        added OnHTTPConnectionEstablished()
//  12-Apr-05   mjkobb      Added GetResponseHeaderValue

---