net_instaweb::FlushHtmlFilter Class Reference

#include "flush_html_filter.h"

Inheritance diagram for net_instaweb::FlushHtmlFilter:

Public Member Functions
	FlushHtmlFilter (RewriteDriver *driver)
virtual void	StartDocumentImpl ()
virtual void	StartElementImpl (HtmlElement *element)
virtual void	EndElementImpl (HtmlElement *element)
virtual void	Flush ()
virtual const char *	Name () const
	The name of this filter – used for logging and debugging.
Public Member Functions inherited from net_instaweb::CommonFilter
	CommonFilter (RewriteDriver *driver)
const GoogleUrl &	base_url () const
	Getters. More...
const GoogleUrl &	decoded_base_url () const
RewriteDriver *	driver () const
HtmlElement *	noscript_element () const
void	InsertNodeAtBodyEnd (HtmlNode *data)
virtual void	StartDocument ()
	Note: Don't overload these methods, overload the implementers instead!
virtual void	StartElement (HtmlElement *element)
virtual void	EndElement (HtmlElement *element)
virtual void	Characters (HtmlCharactersNode *characters)
ResourcePtr	CreateInputResource (StringPiece input_url, RewriteDriver::InputRole role, bool *is_authorized)
ResourcePtr	CreateInputResourceOrInsertDebugComment (StringPiece input_url, RewriteDriver::InputRole role, HtmlElement *element)
void	ResolveUrl (StringPiece input_url, GoogleUrl *out_url)
bool	IsRelativeUrlLoadPermittedByCsp (StringPiece url, CspDirective role)
bool	BaseUrlIsValid () const
bool	DebugMode () const
bool	CanAddPagespeedOnloadToImage (const HtmlElement &)
virtual void	LogFilterModifiedContent ()
virtual RewriteDriver::InlineAuthorizationPolicy	AllowUnauthorizedDomain () const
virtual bool	IntendedForInlining () const
void	AddJsToElement (StringPiece js, HtmlElement *script)
Public Member Functions inherited from net_instaweb::EmptyHtmlFilter
virtual void	EndDocument ()
virtual void	Cdata (HtmlCdataNode *cdata)
	Called for CDATA blocks (e.g. <![CDATA[foobar]]>)
virtual void	Comment (HtmlCommentNode *comment)
	Called for HTML comments that aren't IE directives (e.g. ).
virtual void	IEDirective (HtmlIEDirectiveNode *directive)
virtual void	Directive (HtmlDirectiveNode *directive)
	Called for HTML directives (e.g. <!doctype foobar>).
virtual void	DetermineEnabled (GoogleString *disabled_reason)
virtual bool	CanModifyUrls ()
ScriptUsage	GetScriptUsage () const override
Public Member Functions inherited from net_instaweb::HtmlFilter
virtual void	RenderDone ()
bool	is_enabled () const
void	set_is_enabled (bool is_enabled)

Additional Inherited Members
Public Types inherited from net_instaweb::HtmlFilter
enum	ScriptUsage { kWillInjectScripts, kMayInjectScripts, kNeverInjectsScripts }
	Describes a filter's relationship with scripts. More...
Static Public Member Functions inherited from net_instaweb::CommonFilter
static bool	ExtractMetaTagDetails (const HtmlElement &element, const ResponseHeaders *headers, GoogleString *content, GoogleString *mime_type, GoogleString *charset)
Static Public Attributes inherited from net_instaweb::CommonFilter
static const char	kCreateResourceFailedDebugMsg []
	Debug message to be inserted when resource creation fails.
Protected Member Functions inherited from net_instaweb::CommonFilter
ServerContext *	server_context () const
const RewriteOptions *	rewrite_options ()
virtual const char *	LoggingId ()

Detailed Description

This filter is run immediately after lexing when streaming HTML into the system. It is used to monitor the HTML and try to figure out good times to flush, based on document structure and timing.

Member Function Documentation

virtual void net_instaweb::FlushHtmlFilter::Flush ( )

virtual

Notifies the Filter that a flush is occurring. A filter that's generating streamed output should flush at this time. A filter that's mutating elements can mutate any element seen since the most recent flush; once an element is flushed it is already on the wire to its destination and it's too late to mutate. Flush is initiated by an application calling HttpParse::Flush().

Flush() is called after all other handlers during a HttpParse::Flush(), except RenderDone(), which (if in use) happens after Flush().

Reimplemented from net_instaweb::EmptyHtmlFilter.

virtual void net_instaweb::FlushHtmlFilter::StartDocumentImpl ( )

virtual

Overload these implementer methods: Intentionally left abstract so that implementers don't forget to change the name from Blah to BlahImpl.

Implements net_instaweb::CommonFilter.

---

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

• net/instaweb/rewriter/public/flush_html_filter.h