juce::WebInputStream Class Reference

#include <juce_WebInputStream.h>

Inheritance diagram for juce::WebInputStream:

Classes
class	Listener
class	Pimpl

Public Member Functions
	WebInputStream (const URL &url, bool addParametersToRequestBody)
	~WebInputStream () override
WebInputStream &	withExtraHeaders (const String &extraHeaders)
WebInputStream &	withCustomRequestCommand (const String &customRequestCommand)
WebInputStream &	withConnectionTimeout (int timeoutInMs)
WebInputStream &	withNumRedirectsToFollow (int numRedirects)
bool	connect (Listener *listener)
bool	isError () const
void	cancel ()
StringPairArray	getRequestHeaders () const
StringPairArray	getResponseHeaders ()
int	getStatusCode ()
int64	getTotalLength () override
int	read (void *destBuffer, int maxBytesToRead) override
bool	isExhausted () override
int64	getPosition () override
bool	setPosition (int64 wantedPos) override
Public Member Functions inherited from juce::InputStream
virtual	~InputStream ()=default
int64	getNumBytesRemaining ()
ssize_t	read (void *destBuffer, size_t maxBytesToRead)
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)

Static Private Member Functions
static void	createHeadersAndPostData (const URL &, String &, MemoryBlock &, bool)
static StringPairArray	parseHttpHeaders (const String &)

Private Attributes
std::unique_ptr< Pimpl >	pimpl
bool	hasCalledConnect = false

Friends
class	Pimpl

Additional Inherited Members
Protected Member Functions inherited from juce::InputStream
	InputStream ()=default

Detailed Description

An InputStream which can be used to read from a given URL.

@tags{Core}

Constructor & Destructor Documentation

WebInputStream()

juce::WebInputStream::WebInputStream	(	const URL &	url,
		bool	addParametersToRequestBody )

Creates a new WebInputStream which can be used to read from a URL.

Parameters

url	the URL that should be retrieved. This parameter may also contain POST data and/or parameters.
addParametersToRequestBody	specifies whether any URL parameters that have been set will be transferred via the request body data or added to the URL address. This will also determine whether a POST or GET command will be used if a custom command is not set.

~WebInputStream()

juce::WebInputStream::~WebInputStream ( )

override

Destructor.

Member Function Documentation

cancel()

void juce::WebInputStream::cancel

(

)

Will cancel a blocking read and prevent any subsequent connection attempts.

connect()

bool juce::WebInputStream::connect

(

Listener *

listener

)

Wait until the first byte is ready for reading.

This method will attempt to connect to the URL given in the constructor and block until the status code and all response headers have been received or an error has occurred.

Note that most methods will call connect() internally if they are called without an established connection. Therefore, it is not necessary to explicitly call connect unless you would like to use a custom listener.

After a successful call to connect(), getResponseHeaders(), getTotalLength() and getStatusCode() will all be non-blocking.

Parameters

listener

a listener to receive progress callbacks on the status of a POST data upload.

See also

getResponseHeaders, getTotalLength, getStatusCode

createHeadersAndPostData()

void juce::WebInputStream::createHeadersAndPostData ( const URL & aURL, String & headers, MemoryBlock & data, bool addParametersToBody )

staticprivate

getPosition()

int64 juce::WebInputStream::getPosition ( )

overridevirtual

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

See also

setPosition

Implements juce::InputStream.

getRequestHeaders()

StringPairArray juce::WebInputStream::getRequestHeaders

(

)

const

Returns a StringPairArray of the request headers.

getResponseHeaders()

StringPairArray juce::WebInputStream::getResponseHeaders

(

)

Returns a StringPairArray of response headers.

If getResponseHeaders() is called without an established connection, then getResponseHeaders() will call connect internally and block until connect returns - either due to a successful connection or a connection error.

See also

connect

getStatusCode()

int juce::WebInputStream::getStatusCode

(

)

Returns the status code returned by the HTTP server

If getStatusCode() is called without an established connection, then getStatusCode() will call connect internally and block until connect returns - either due to a successful connection or a connection error.

See also

connect

getTotalLength()

int64 juce::WebInputStream::getTotalLength ( )

overridevirtual

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 getTotalLength() is called without an established connection, then getTotalLength() will call connect internally and block until connect returns - either due to a successful connection or a connection error.

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

Implements juce::InputStream.

isError()

bool juce::WebInputStream::isError

(

)

const

Returns true if there was an error during the connection attempt.

isExhausted()

bool juce::WebInputStream::isExhausted ( )

overridevirtual

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

Implements juce::InputStream.

parseHttpHeaders()

StringPairArray juce::WebInputStream::parseHttpHeaders ( const String & headerData )

staticprivate

read()

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

overridevirtual

Reads some data from the stream into a memory buffer.

This method will block until the maxBytesToRead bytes are available.

This method calls connect() internally if the connection hasn't already been established.

Parameters

destBuffer	the destination buffer for the data. This must not be null.
maxBytesToRead	the 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 juce::InputStream.

setPosition()

bool juce::WebInputStream::setPosition ( int64 wantedPos )

overridevirtual

Tries to move the current read position of the stream.

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

For a WebInputStream, this method will fail if wantedPos is smaller than the current position. If wantedPos is greater than the current position, then calling setPosition() is the same as calling read(), i.e. the skipped data will still be downloaded, although skipped bytes will be discarded immediately.

Returns

true if the stream manages to reposition itself correctly

See also

getPosition

Implements juce::InputStream.

withConnectionTimeout()

WebInputStream & juce::WebInputStream::withConnectionTimeout

(

int

timeoutInMs

)

Specify the connection time-out.

Returns a reference to itself so that several methods can be chained.

Parameters

timeoutInMs

the number of milliseconds to wait until the connection request is aborted.

withCustomRequestCommand()

WebInputStream & juce::WebInputStream::withCustomRequestCommand

(

const String &

customRequestCommand

)

Override the HTTP command that is sent.

Returns a reference to itself so that several methods can be chained.

Note that this command will not change the way parameters are sent. This must be specified in the constructor.

Parameters

customRequestCommand

this string is the custom HTTP request command such as POST or GET.

withExtraHeaders()

WebInputStream & juce::WebInputStream::withExtraHeaders

(

const String &

extraHeaders

)

Add extra headers to the HTTP request.

Returns a reference to itself so that several methods can be chained.

Parameters

extraHeaders

this string is appended onto the headers that are used for the request. It must therefore be a valid set of HTML header directives, separated by newlines.

withNumRedirectsToFollow()

WebInputStream & juce::WebInputStream::withNumRedirectsToFollow

(

int

numRedirects

)

Specify the number of redirects to be followed.

Returns a reference to itself so that several methods can be chained.

Parameters

numRedirects

specifies the number of redirects that will be followed before returning a response (ignored for Android which follows up to 5 redirects)

Friends And Related Symbol Documentation

Pimpl

friend class Pimpl

friend

Member Data Documentation

hasCalledConnect

bool juce::WebInputStream::hasCalledConnect = false

private

pimpl

std::unique_ptr<Pimpl> juce::WebInputStream::pimpl

private

---

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

• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_core/network/juce_WebInputStream.h
• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_core/network/juce_WebInputStream.cpp