OpenShot Library | libopenshot-audio 0.2.0
juce::FallbackDownloadTask Struct Reference
+ Inheritance diagram for juce::FallbackDownloadTask:

Public Member Functions

 FallbackDownloadTask (FileOutputStream *outputStreamToUse, size_t bufferSizeToUse, WebInputStream *streamToUse, URL::DownloadTask::Listener *listenerToUse)
 
void run () override
 Must be implemented to perform the thread's actual code.
 
- Public Member Functions inherited from juce::URL::DownloadTask
virtual ~DownloadTask ()
 Releases the resources of the download task, unregisters the listener and cancels the download if necessary.
 
int64 getTotalLength () const
 Returns the total length of the download task.
 
int64 getLengthDownloaded () const
 Returns the number of bytes that have been downloaded so far.
 
bool isFinished () const
 Returns true if the download finished or there was an error.
 
int statusCode () const
 Returns the status code of the server's response.
 
bool hadError () const
 Returns true if there was an error.
 
File getTargetLocation () const
 Returns the target file location that was provided in URL::downloadToFile.
 
- Public Member Functions inherited from juce::Thread
 Thread (const String &threadName, size_t threadStackSize=0)
 Creates a thread.
 
virtual ~Thread ()
 Destructor.
 
void startThread ()
 Starts the thread running.
 
void startThread (int priority)
 Starts the thread with a given priority.
 
bool stopThread (int timeOutMilliseconds)
 Attempts to stop the thread running.
 
bool isThreadRunning () const
 Returns true if the thread is currently active.
 
void signalThreadShouldExit ()
 Sets a flag to tell the thread it should stop.
 
bool threadShouldExit () const
 Checks whether the thread has been told to stop running.
 
bool waitForThreadToExit (int timeOutMilliseconds) const
 Waits for the thread to stop.
 
void addListener (Listener *)
 Add a listener to this thread which will receive a callback when signalThreadShouldExit was called on this thread.
 
void removeListener (Listener *)
 Removes a listener added with addListener.
 
bool setPriority (int priority)
 Changes the thread's priority.
 
void setAffinityMask (uint32 affinityMask)
 Sets the affinity mask for the thread.
 
bool wait (int timeOutMilliseconds) const
 Suspends the execution of this thread until either the specified timeout period has elapsed, or another thread calls the notify() method to wake it up.
 
void notify () const
 Wakes up the thread.
 
ThreadID getThreadId () const noexcept
 Returns the ID of this thread.
 
const StringgetThreadName () const noexcept
 Returns the name of the thread.
 

Public Attributes

const std::unique_ptr< FileOutputStreamfileStream
 
const std::unique_ptr< WebInputStreamstream
 
const size_t bufferSize
 
HeapBlock< charbuffer
 
URL::DownloadTask::Listener *const listener
 

Additional Inherited Members

- Public Types inherited from juce::Thread
enum  { realtimeAudioPriority = -1 }
 Special realtime audio thread priority. More...
 
using ThreadID = void *
 A value type used for thread IDs.
 
- Static Public Member Functions inherited from juce::URL::DownloadTask
static void juce_iosURLSessionNotify (const String &)
 internal
 
- Static Public Member Functions inherited from juce::Thread
static void launch (std::function< void()> functionToRun)
 Invokes a lambda or function on its own thread.
 
static bool currentThreadShouldExit ()
 Checks whether the current thread has been told to stop running.
 
static bool setCurrentThreadPriority (int priority)
 Changes the priority of the caller thread.
 
static void JUCE_CALLTYPE setCurrentThreadAffinityMask (uint32 affinityMask)
 Changes the affinity mask for the caller thread.
 
static void JUCE_CALLTYPE sleep (int milliseconds)
 Suspends the execution of the current thread until the specified timeout period has elapsed (note that this may not be exact).
 
static void JUCE_CALLTYPE yield ()
 Yields the current thread's CPU time-slot and allows a new thread to run.
 
static ThreadID JUCE_CALLTYPE getCurrentThreadId ()
 Returns an id that identifies the caller thread.
 
static Thread *JUCE_CALLTYPE getCurrentThread ()
 Finds the thread object that is currently running.
 
static void JUCE_CALLTYPE setCurrentThreadName (const String &newThreadName)
 Changes the name of the caller thread.
 
static void initialiseJUCE (void *jniEnv, void *jContext)
 Initialises the JUCE subsystem for projects not created by the Projucer.
 
- Protected Attributes inherited from juce::URL::DownloadTask
int64 contentLength = -1
 
int64 downloaded = 0
 
bool finished = false
 
bool error = false
 
int httpCode = -1
 
File targetLocation
 

Detailed Description

Definition at line 26 of file juce_URL.cpp.

Constructor & Destructor Documentation

◆ FallbackDownloadTask()

juce::FallbackDownloadTask::FallbackDownloadTask ( FileOutputStream outputStreamToUse,
size_t  bufferSizeToUse,
WebInputStream streamToUse,
URL::DownloadTask::Listener listenerToUse 
)
inline

Definition at line 29 of file juce_URL.cpp.

◆ ~FallbackDownloadTask()

juce::FallbackDownloadTask::~FallbackDownloadTask ( )
inlineoverride

Definition at line 50 of file juce_URL.cpp.

Member Function Documentation

◆ run()

void juce::FallbackDownloadTask::run ( )
inlineoverridevirtual

Must be implemented to perform the thread's actual code.

Remember that the thread must regularly check the threadShouldExit() method whilst running, and if this returns true it should return from the run() method as soon as possible to avoid being forcibly killed.

See also
threadShouldExit, startThread

Implements juce::Thread.

Definition at line 58 of file juce_URL.cpp.

References juce::URL::DownloadTask::Listener::finished(), juce::HeapBlock< ElementType, throwOnFailure >::get(), juce::URL::DownloadTask::Listener::progress(), and juce::Thread::threadShouldExit().

Member Data Documentation

◆ fileStream

const std::unique_ptr<FileOutputStream> juce::FallbackDownloadTask::fileStream

Definition at line 100 of file juce_URL.cpp.

◆ stream

const std::unique_ptr<WebInputStream> juce::FallbackDownloadTask::stream

Definition at line 101 of file juce_URL.cpp.

◆ bufferSize

const size_t juce::FallbackDownloadTask::bufferSize

Definition at line 102 of file juce_URL.cpp.

◆ buffer

HeapBlock<char> juce::FallbackDownloadTask::buffer

Definition at line 103 of file juce_URL.cpp.

◆ listener

URL::DownloadTask::Listener* const juce::FallbackDownloadTask::listener

Definition at line 104 of file juce_URL.cpp.


The documentation for this struct was generated from the following file: