Page Speed Optimization Libraries
1.7.30.4
|
#include "request_context.h"
Classes | |
class | TimingInfo |
Public Types | |
enum | SplitRequestType { SPLIT_FULL, SPLIT_ABOVE_THE_FOLD, SPLIT_BELOW_THE_FOLD } |
Types of split html request. | |
Public Member Functions | |
RequestContext (AbstractMutex *logging_mutex, Timer *timer) | |
virtual AbstractLogRecord * | NewSubordinateLogRecord (AbstractMutex *logging_mutex) |
RequestTrace * | root_trace_context () |
void | set_root_trace_context (RequestTrace *x) |
Takes ownership of the given context. | |
virtual RequestTrace * | CreateDependentTraceContext (const StringPiece &label) |
virtual void | ReleaseDependentTraceContext (RequestTrace *t) |
virtual AbstractLogRecord * | log_record () |
The log record for the this request, created when the request context is. | |
bool | using_spdy () const |
Determines whether this request is using the SPDY protocol. | |
void | set_using_spdy (bool x) |
const GoogleString & | minimal_private_suffix () const |
void | set_minimal_private_suffix (StringPiece minimal_private_suffix) |
void | set_accepts_webp (bool x) |
bool | accepts_webp () const |
SplitRequestType | split_request_type () const |
Indicates the type of split html request. | |
void | set_split_request_type (SplitRequestType type) |
int64 | request_id () const |
void | set_request_id (int64 x) |
void | AddSessionAuthorizedFetchOrigin (const GoogleString &origin) |
bool | IsSessionAuthorizedFetchOrigin (const GoogleString &origin) const |
void | PrepareLogRecordForOutput () |
void | WriteBackgroundRewriteLog () |
Write the log for background rewriting into disk. | |
AbstractLogRecord * | GetBackgroundRewriteLog (ThreadSystem *thread_system, bool log_urls, bool log_url_indices, int max_rewrite_info_log_size) |
const TimingInfo & | timing_info () const |
TimingInfo * | mutable_timing_info () |
Static Public Member Functions | |
static RequestContextPtr | NewTestRequestContext (ThreadSystem *thread_system) |
static RequestContextPtr | NewTestRequestContextWithTimer (ThreadSystem *thread_system, Timer *timer) |
static RequestContextPtr | NewTestRequestContext (AbstractLogRecord *log_record) |
Protected Member Functions | |
RequestContext (AbstractMutex *mutex, Timer *timer, AbstractLogRecord *log_record) | |
virtual | ~RequestContext () |
Destructors in refcounted classes should be protected. | |
REFCOUNT_FRIEND_DECLARATION (RequestContext) |
A class which wraps state associated with a request.
This object should be reference counted, wrapped in a RequestContextPtr. We use reference counting because, depending on the timing of asynchronous rewrites, RPC calls, and so on, a RequestContext may outlive the original HTTP request serving, or not. Reference counting avoids the complexity of explicit transfer of ownership in these cases.
net_instaweb::RequestContext::RequestContext | ( | AbstractMutex * | logging_mutex, |
Timer * | timer | ||
) |
|logging_mutex| will be passed to the request context's AbstractLogRecord, which will take ownership of it. If you will be doing logging in a real (threaded) environment, pass in a real mutex. If not, a NullMutex is fine. |timer| will be passed to the TimingInfo, which will *not* take ownership. Passing NULL for |timer| is allowed.
net_instaweb::RequestContext::RequestContext | ( | AbstractMutex * | mutex, |
Timer * | timer, | ||
AbstractLogRecord * | log_record | ||
) | [protected] |
virtual RequestTrace* net_instaweb::RequestContext::CreateDependentTraceContext | ( | const StringPiece & | label | ) | [inline, virtual] |
Creates a new RequestTrace associated with a request depending on the root user request; e.g., a subresource fetch for an HTML page.
This implementation is a no-op. Subclasses should customize this based on their underlying tracing system. A few interface notes:
AbstractLogRecord* net_instaweb::RequestContext::GetBackgroundRewriteLog | ( | ThreadSystem * | thread_system, |
bool | log_urls, | ||
bool | log_url_indices, | ||
int | max_rewrite_info_log_size | ||
) |
Return the log record for background rewrites. If it doesn't exist, create a new one.
bool net_instaweb::RequestContext::IsSessionAuthorizedFetchOrigin | ( | const GoogleString & | origin | ) | const [inline] |
Returns true for exactly the origins that were authorized for this particular session by calls to AddSessionAuthorizedFetchOrigin()
const GoogleString& net_instaweb::RequestContext::minimal_private_suffix | ( | ) | const [inline] |
The minimal private suffix for the hostname specified in this request. This should be calculated from the hostname by considering the list of public suffixes and including one additional component. So if a host is "a.b.c.d.e.f.g" and "e.f.g" is on the public suffix list then the minimal private suffix is "d.e.f.g".
There are two ways of specifying the host -- with the Host header, or on the initial request line. The caller should make sure to look in both places.
If a system doesn't want to fragment the cache by minimal private suffix, it may set value to the empty string.
virtual AbstractLogRecord* net_instaweb::RequestContext::NewSubordinateLogRecord | ( | AbstractMutex * | logging_mutex | ) | [virtual] |
Creates a new, unowned AbstractLogRecord, for use by some subordinate action. Also useful in case of background activity where logging is required after the response is written out, e.g., blink flow.
static RequestContextPtr net_instaweb::RequestContext::NewTestRequestContext | ( | ThreadSystem * | thread_system | ) | [inline, static] |
Prepare the AbstractLogRecord for a subsequent call to WriteLog. This might include propagating information collected in the RequestContext, TimingInfo for example, to the underlying logging infrastructure.
virtual void net_instaweb::RequestContext::ReleaseDependentTraceContext | ( | RequestTrace * | t | ) | [virtual] |
Releases this object's reference to the given context and frees memory. Calls to CreateDependentTraceContext need not be matched by calls to this function. If a dependent trace span is not released when the request context reference count drops to zero, this object will clean all dependent traces.
Note that automatic cleanup of dependent traces is provided for safety. To provide meaningful performance statistics, cleanup should be coupled with the completion of the event being traced.
Subclasses should customize this based on their underlying tracing system.
RequestTrace* net_instaweb::RequestContext::root_trace_context | ( | ) | [inline] |
The root trace context is associated with the user request which we are attempting to serve. If this is a request with constituent resources that we rewrite, there may be several dependent fetches synthesized by PSOL during rewrites. Those are traced separately.
void net_instaweb::RequestContext::set_accepts_webp | ( | bool | x | ) | [inline] |
Indicates whether the request-headers tell us that a browser can render webp images.