openshot-audio  0.1.6
Public Member Functions | Public Attributes | List of all members
WebInputStream Class Reference
Inheritance diagram for WebInputStream:
InputStream InputStream InputStream InputStream

Public Member Functions

 WebInputStream (String address, bool isPost, const MemoryBlock &postData, URL::OpenStreamProgressCallback *progressCallback, void *progressCallbackContext, const String &headers, int timeOutMs, StringPairArray *responseHeaders, const int numRedirectsToFollow)
 
 ~WebInputStream ()
 
bool isError () const
 
bool isExhausted () override
 
int64 getTotalLength () override
 
int64 getPosition () override
 
bool setPosition (int64 wantedPos) override
 
int read (void *buffer, int bytesToRead) override
 
 WebInputStream (const String &address, bool isPost, const MemoryBlock &postData, URL::OpenStreamProgressCallback *progressCallback, void *progressCallbackContext, const String &headers, int timeOutMs, StringPairArray *responseHeaders, const int maxRedirects)
 
 ~WebInputStream ()
 
bool isError () const
 
bool isExhausted () override
 
int64 getPosition () override
 
int64 getTotalLength () override
 
int read (void *buffer, int bytesToRead) override
 
bool setPosition (int64 wantedPos) override
 
 WebInputStream (const String &address_, bool isPost_, const MemoryBlock &postData_, URL::OpenStreamProgressCallback *progressCallback, void *progressCallbackContext, const String &headers_, int timeOutMs_, StringPairArray *responseHeaders, const int maxRedirects)
 
 ~WebInputStream ()
 
bool isError () const
 
bool isExhausted () override
 
int64 getPosition () override
 
int64 getTotalLength () override
 
int read (void *buffer, int bytesToRead) override
 
bool setPosition (int64 wantedPos) override
 
 WebInputStream (const String &address_, bool isPost_, const MemoryBlock &postData_, URL::OpenStreamProgressCallback *progressCallback, void *progressCallbackContext, const String &headers_, int timeOutMs_, StringPairArray *responseHeaders, int numRedirectsToFollow)
 
 ~WebInputStream ()
 
bool isError () const
 
bool isExhausted ()
 
int64 getPosition ()
 
int64 getTotalLength ()
 
int read (void *buffer, int bytesToRead)
 
bool setPosition (int64 wantedPos)
 
- Public Member Functions inherited from InputStream
virtual ~InputStream ()
 
int64 getNumBytesRemaining ()
 
virtual char readByte ()
 
virtual bool readBool ()
 
virtual short readShort ()
 
virtual short readShortBigEndian ()
 
virtual int readInt ()
 
virtual int readIntBigEndian ()
 
virtual int64 readInt64 ()
 
virtual int64 readInt64BigEndian ()
 
virtual float readFloat ()
 
virtual float readFloatBigEndian ()
 
virtual double readDouble ()
 
virtual double readDoubleBigEndian ()
 
virtual int readCompressedInt ()
 
virtual String readNextLine ()
 
virtual String readString ()
 
virtual String readEntireStreamAsString ()
 
virtual size_t readIntoMemoryBlock (MemoryBlock &destBlock, ssize_t maxNumBytesToRead=-1)
 
virtual void skipNextBytes (int64 numBytesToSkip)
 

Public Attributes

GlobalRef stream
 
int statusCode
 

Additional Inherited Members

- Protected Member Functions inherited from InputStream
 InputStream () noexcept
 

Constructor & Destructor Documentation

WebInputStream::WebInputStream ( String  address,
bool  isPost,
const MemoryBlock postData,
URL::OpenStreamProgressCallback progressCallback,
void *  progressCallbackContext,
const String headers,
int  timeOutMs,
StringPairArray responseHeaders,
const int  numRedirectsToFollow 
)
inline
WebInputStream::~WebInputStream ( )
inline
WebInputStream::WebInputStream ( const String address,
bool  isPost,
const MemoryBlock postData,
URL::OpenStreamProgressCallback progressCallback,
void *  progressCallbackContext,
const String headers,
int  timeOutMs,
StringPairArray responseHeaders,
const int  maxRedirects 
)
inline
WebInputStream::~WebInputStream ( )
inline
WebInputStream::WebInputStream ( const String address_,
bool  isPost_,
const MemoryBlock postData_,
URL::OpenStreamProgressCallback progressCallback,
void *  progressCallbackContext,
const String headers_,
int  timeOutMs_,
StringPairArray responseHeaders,
const int  maxRedirects 
)
inline
WebInputStream::~WebInputStream ( )
inline
WebInputStream::WebInputStream ( const String address_,
bool  isPost_,
const MemoryBlock postData_,
URL::OpenStreamProgressCallback progressCallback,
void *  progressCallbackContext,
const String headers_,
int  timeOutMs_,
StringPairArray responseHeaders,
int  numRedirectsToFollow 
)
inline
WebInputStream::~WebInputStream ( )
inline

Member Function Documentation

int64 WebInputStream::getPosition ( )
inlineoverridevirtual

Returns the offset of the next byte that will be read from the stream.

See also
setPosition

Implements InputStream.

int64 WebInputStream::getPosition ( )
inlineoverridevirtual

Returns the offset of the next byte that will be read from the stream.

See also
setPosition

Implements InputStream.

int64 WebInputStream::getPosition ( )
inlinevirtual

Returns the offset of the next byte that will be read from the stream.

See also
setPosition

Implements InputStream.

int64 WebInputStream::getPosition ( )
inlineoverridevirtual

Returns the offset of the next byte that will be read from the stream.

See also
setPosition

Implements InputStream.

int64 WebInputStream::getTotalLength ( )
inlineoverridevirtual

Returns the total number of bytes available for reading in this stream.

Note that this is the number of bytes available from the start of the stream, not from the current position.

If the size of the stream isn't actually known, this will return -1.

See also
getNumBytesRemaining

Implements InputStream.

int64 WebInputStream::getTotalLength ( )
inlineoverridevirtual

Returns the total number of bytes available for reading in this stream.

Note that this is the number of bytes available from the start of the stream, not from the current position.

If the size of the stream isn't actually known, this will return -1.

See also
getNumBytesRemaining

Implements InputStream.

int64 WebInputStream::getTotalLength ( )
inlinevirtual

Returns the total number of bytes available for reading in this stream.

Note that this is the number of bytes available from the start of the stream, not from the current position.

If the size of the stream isn't actually known, this will return -1.

See also
getNumBytesRemaining

Implements InputStream.

int64 WebInputStream::getTotalLength ( )
inlineoverridevirtual

Returns the total number of bytes available for reading in this stream.

Note that this is the number of bytes available from the start of the stream, not from the current position.

If the size of the stream isn't actually known, this will return -1.

See also
getNumBytesRemaining

Implements InputStream.

bool WebInputStream::isError ( ) const
inline
bool WebInputStream::isError ( ) const
inline
bool WebInputStream::isError ( ) const
inline
bool WebInputStream::isError ( ) const
inline
bool WebInputStream::isExhausted ( )
inlineoverridevirtual

Returns true if the stream has no more data to read.

Implements InputStream.

bool WebInputStream::isExhausted ( )
inlineoverridevirtual

Returns true if the stream has no more data to read.

Implements InputStream.

bool WebInputStream::isExhausted ( )
inlinevirtual

Returns true if the stream has no more data to read.

Implements InputStream.

bool WebInputStream::isExhausted ( )
inlineoverridevirtual

Returns true if the stream has no more data to read.

Implements InputStream.

int WebInputStream::read ( void *  destBuffer,
int  maxBytesToRead 
)
inlineoverridevirtual

Reads some data from the stream into a memory buffer.

This is the only read method that subclasses actually need to implement, as the InputStream base class implements the other read methods in terms of this one (although it's often more efficient for subclasses to implement them directly).

Parameters
destBufferthe destination buffer for the data. This must not be null.
maxBytesToReadthe maximum number of bytes to read - make sure the memory block passed in is big enough to contain this many bytes. This value must not be negative.
Returns
the actual number of bytes that were read, which may be less than maxBytesToRead if the stream is exhausted before it gets that far

Implements InputStream.

int WebInputStream::read ( void *  destBuffer,
int  maxBytesToRead 
)
inlineoverridevirtual

Reads some data from the stream into a memory buffer.

This is the only read method that subclasses actually need to implement, as the InputStream base class implements the other read methods in terms of this one (although it's often more efficient for subclasses to implement them directly).

Parameters
destBufferthe destination buffer for the data. This must not be null.
maxBytesToReadthe maximum number of bytes to read - make sure the memory block passed in is big enough to contain this many bytes. This value must not be negative.
Returns
the actual number of bytes that were read, which may be less than maxBytesToRead if the stream is exhausted before it gets that far

Implements InputStream.

int WebInputStream::read ( void *  destBuffer,
int  maxBytesToRead 
)
inlinevirtual

Reads some data from the stream into a memory buffer.

This is the only read method that subclasses actually need to implement, as the InputStream base class implements the other read methods in terms of this one (although it's often more efficient for subclasses to implement them directly).

Parameters
destBufferthe destination buffer for the data. This must not be null.
maxBytesToReadthe maximum number of bytes to read - make sure the memory block passed in is big enough to contain this many bytes. This value must not be negative.
Returns
the actual number of bytes that were read, which may be less than maxBytesToRead if the stream is exhausted before it gets that far

Implements InputStream.

int WebInputStream::read ( void *  destBuffer,
int  maxBytesToRead 
)
inlineoverridevirtual

Reads some data from the stream into a memory buffer.

This is the only read method that subclasses actually need to implement, as the InputStream base class implements the other read methods in terms of this one (although it's often more efficient for subclasses to implement them directly).

Parameters
destBufferthe destination buffer for the data. This must not be null.
maxBytesToReadthe maximum number of bytes to read - make sure the memory block passed in is big enough to contain this many bytes. This value must not be negative.
Returns
the actual number of bytes that were read, which may be less than maxBytesToRead if the stream is exhausted before it gets that far

Implements InputStream.

bool WebInputStream::setPosition ( int64  newPosition)
inlineoverridevirtual

Tries to move the current read position of the stream.

The position is an absolute number of bytes from the stream's start.

Some streams might not be able to do this, in which case they should do nothing and return false. Others might be able to manage it by resetting themselves and skipping to the correct position, although this is obviously a bit slow.

Returns
true if the stream manages to reposition itself correctly
See also
getPosition

Implements InputStream.

bool WebInputStream::setPosition ( int64  newPosition)
inlineoverridevirtual

Tries to move the current read position of the stream.

The position is an absolute number of bytes from the stream's start.

Some streams might not be able to do this, in which case they should do nothing and return false. Others might be able to manage it by resetting themselves and skipping to the correct position, although this is obviously a bit slow.

Returns
true if the stream manages to reposition itself correctly
See also
getPosition

Implements InputStream.

bool WebInputStream::setPosition ( int64  newPosition)
inlinevirtual

Tries to move the current read position of the stream.

The position is an absolute number of bytes from the stream's start.

Some streams might not be able to do this, in which case they should do nothing and return false. Others might be able to manage it by resetting themselves and skipping to the correct position, although this is obviously a bit slow.

Returns
true if the stream manages to reposition itself correctly
See also
getPosition

Implements InputStream.

bool WebInputStream::setPosition ( int64  newPosition)
inlineoverridevirtual

Tries to move the current read position of the stream.

The position is an absolute number of bytes from the stream's start.

Some streams might not be able to do this, in which case they should do nothing and return false. Others might be able to manage it by resetting themselves and skipping to the correct position, although this is obviously a bit slow.

Returns
true if the stream manages to reposition itself correctly
See also
getPosition

Implements InputStream.

Member Data Documentation

int WebInputStream::statusCode
GlobalRef WebInputStream::stream

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