audacity::network_manager::RequestPayloadStream Class Reference

#include <RequestPayload.h>

Inheritance diagram for audacity::network_manager::RequestPayloadStream:

Public Types
enum class	SeekDirection { Start , Current , End }

Public Member Functions
virtual	~RequestPayloadStream ()
virtual bool	HasData () const =0
	return true on if stream is not empty More...
virtual int64_t	GetDataSize () const =0
	May return 0 even if HasData() returns true. More...
virtual bool	Seek (int64_t offset, SeekDirection direction)=0
	returns true on success More...
virtual int64_t	Read (void *buffer, int64_t size)=0
	returns number of bytes read More...

Detailed Description

Definition at line 19 of file RequestPayload.h.

Member Enumeration Documentation

SeekDirection

enum class audacity::network_manager::RequestPayloadStream::SeekDirection

strong

Enumerator
Start
Current
End

Definition at line 30 of file RequestPayload.h.

   {
      Start,
      Current,
      End
   };

Constructor & Destructor Documentation

~RequestPayloadStream()

audacity::network_manager::RequestPayloadStream::~RequestPayloadStream ( )

virtual

Definition at line 179 of file RequestPayload.cpp.

{
}

Member Function Documentation

GetDataSize()

virtual int64_t audacity::network_manager::RequestPayloadStream::GetDataSize ( ) const

pure virtual

May return 0 even if HasData() returns true.

Implemented in audacity::network_manager::anonymous_namespace{RequestPayload.cpp}::EmptyRequestPayloadStream, audacity::network_manager::anonymous_namespace{RequestPayload.cpp}::MemoryRequestPayloadStream, and audacity::network_manager::anonymous_namespace{RequestPayload.cpp}::FileRequestPayloadStream.

HasData()

virtual bool audacity::network_manager::RequestPayloadStream::HasData ( ) const

pure virtual

return true on if stream is not empty

Implemented in audacity::network_manager::anonymous_namespace{RequestPayload.cpp}::EmptyRequestPayloadStream, audacity::network_manager::anonymous_namespace{RequestPayload.cpp}::MemoryRequestPayloadStream, and audacity::network_manager::anonymous_namespace{RequestPayload.cpp}::FileRequestPayloadStream.

Read()

virtual int64_t audacity::network_manager::RequestPayloadStream::Read ( void *  buffer, int64_t  size  )

pure virtual

returns number of bytes read

Implemented in audacity::network_manager::anonymous_namespace{RequestPayload.cpp}::EmptyRequestPayloadStream, audacity::network_manager::anonymous_namespace{RequestPayload.cpp}::MemoryRequestPayloadStream, and audacity::network_manager::anonymous_namespace{RequestPayload.cpp}::FileRequestPayloadStream.

Referenced by audacity::network_manager::anonymous_namespace{CurlResponse.cpp}::DataStreamRead().

Here is the caller graph for this function:

Seek()

virtual bool audacity::network_manager::RequestPayloadStream::Seek ( int64_t  offset, SeekDirection  direction  )

pure virtual

returns true on success

Implemented in audacity::network_manager::anonymous_namespace{RequestPayload.cpp}::EmptyRequestPayloadStream, audacity::network_manager::anonymous_namespace{RequestPayload.cpp}::MemoryRequestPayloadStream, and audacity::network_manager::anonymous_namespace{RequestPayload.cpp}::FileRequestPayloadStream.

Referenced by audacity::network_manager::anonymous_namespace{CurlResponse.cpp}::DataStreamSeek().

Here is the caller graph for this function:

---

The documentation for this class was generated from the following files:

• RequestPayload.h
• RequestPayload.cpp