FireBreath  1.4.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
FB::DefaultBrowserStreamHandler Class Reference

Simple implementation of a stream event handler from which you can derive your own stream events handler. More...

#include "DefaultBrowserStreamHandler.h"

Inheritance diagram for FB::DefaultBrowserStreamHandler:
Inheritance graph
Collaboration diagram for FB::DefaultBrowserStreamHandler:
Collaboration graph

Public Member Functions

 DefaultBrowserStreamHandler ()
 Default constructor. More...
 
virtual ~DefaultBrowserStreamHandler ()
 Destructor. More...
 
virtual bool onStreamAttached (FB::AttachedEvent *evt, FB::BrowserStream *Stream)
 Called when the stream is attached to this handler (may have already been created). More...
 
virtual bool onStreamDetached (FB::DetachedEvent *evt, FB::BrowserStream *Stream)
 Called when the stream is detached from this handler (may not have been destroyed). More...
 
virtual bool onStreamCreated (FB::StreamCreatedEvent *evt, FB::BrowserStream *Stream)
 Called when the stream was created. More...
 
virtual bool onStreamDestroyed (FB::StreamDestroyedEvent *evt, FB::BrowserStream *)
 Called when the stream is destroyed. More...
 
virtual bool onStreamDataArrived (FB::StreamDataArrivedEvent *evt, FB::BrowserStream *)
 Called when data arrives. More...
 
virtual bool onStreamFailedOpen (FB::StreamFailedOpenEvent *evt, FB::BrowserStream *)
 Called when the stream failed to open. More...
 
virtual bool onStreamOpened (FB::StreamOpenedEvent *evt, FB::BrowserStream *)
 Called when the stream was opened successfully. More...
 
virtual bool onStreamCompleted (FB::StreamCompletedEvent *evt, FB::BrowserStream *)
 Called when the stream finished downloading successfully. More...
 
virtual const
FB::BrowserStreamPtr & 
getStream () const
 Call to get the stream associated with this handler. Returns empty shared_ptr if none. More...
 
virtual bool cancel ()
 Cancels the stream. More...
 
- Public Member Functions inherited from FB::PluginEventSink
virtual bool HandleEvent (PluginEvent *event, PluginEventSource *source)=0
 Called by the browser when a system event needs to be handled, such as a mouse event, a keyboard event, or a drawing event. More...
 

Protected Member Functions

virtual void setStream (const FB::BrowserStreamPtr &stream)
 Call to set the stream associated with this handler. More...
 
virtual void clearStream ()
 Call to clear the stream associated with this handler. More...
 

Protected Attributes

BrowserStreamPtr stream
 stream instance, don't use yourself More...
 

Detailed Description

Simple implementation of a stream event handler from which you can derive your own stream events handler.

This class is a convenience implementation of an event handler for the stream events generated by BrowserStream. You can derive your own stream event handler class from this class and override only the onStream* methods you'll need. Then attach instances of your custom class to a BrowserStream instance.

Author
Matthias

Definition at line 36 of file DefaultBrowserStreamHandler.h.


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