bes Updated for version 3.20.13
http::EffectiveUrl Class Reference

#include <EffectiveUrl.h>

Collaboration diagram for http::EffectiveUrl:
Collaboration graph

Public Member Functions

std::string dump () override
 A string dump of the instance.
 
 EffectiveUrl (const std::shared_ptr< http::EffectiveUrl > &source_url)
 
 EffectiveUrl (const std::shared_ptr< http::EffectiveUrl > &source_url, bool trusted)
 
 EffectiveUrl (const std::string &url_s, bool trusted=false)
 
 EffectiveUrl (const std::string &url_s, const std::vector< std::string > &resp_hdrs, bool trusted=false)
 
 EffectiveUrl (EffectiveUrl const &src_url)
 
 EffectiveUrl (http::url const &src_url)
 
 EffectiveUrl (std::shared_ptr< http::url > source_url)
 
void get_header (const std::string &name, std::string &value, bool &found)
 get the value of the named header
 
virtual std::string host () const
 
void ingest_response_headers (const std::vector< std::string > &resp_hdrs)
 Ingests the passed response hedaers.
 
virtual std::time_t ingest_time () const
 
bool is_expired () override
 Returns true if URL is reusable, false otherwise.
 
virtual bool is_trusted ()
 
virtual std::string path () const
 
virtual std::string protocol () const
 
virtual std::string query () const
 
virtual std::string query_parameter_value (const std::string &key) const
 
virtual void query_parameter_values (const std::string &key, std::vector< std::string > &values) const
 
virtual void set_ingest_time (const std::time_t &itime)
 
virtual std::string str () const
 

Detailed Description

An EffectiveUrl is always acquired by following redirects and so may include response headers received with the final redirect response.

Definition at line 48 of file EffectiveUrl.h.

Constructor & Destructor Documentation

◆ EffectiveUrl() [1/8]

http::EffectiveUrl::EffectiveUrl ( )
explicit

Definition at line 59 of file EffectiveUrl.cc.

◆ EffectiveUrl() [2/8]

http::EffectiveUrl::EffectiveUrl ( const std::string &  url_s,
bool  trusted = false 
)
inlineexplicit

Definition at line 62 of file EffectiveUrl.h.

◆ EffectiveUrl() [3/8]

http::EffectiveUrl::EffectiveUrl ( const std::string &  url_s,
const std::vector< std::string > &  resp_hdrs,
bool  trusted = false 
)
inlineexplicit

Definition at line 64 of file EffectiveUrl.h.

◆ EffectiveUrl() [4/8]

http::EffectiveUrl::EffectiveUrl ( EffectiveUrl const &  src_url)
inline

Copy constructor

Parameters
src_url

Definition at line 72 of file EffectiveUrl.h.

◆ EffectiveUrl() [5/8]

http::EffectiveUrl::EffectiveUrl ( http::url const &  src_url)
inlineexplicit

Copy constructor

Parameters
src_url

Definition at line 82 of file EffectiveUrl.h.

◆ EffectiveUrl() [6/8]

http::EffectiveUrl::EffectiveUrl ( const std::shared_ptr< http::EffectiveUrl > &  source_url)
inlineexplicit

Definition at line 89 of file EffectiveUrl.h.

◆ EffectiveUrl() [7/8]

http::EffectiveUrl::EffectiveUrl ( const std::shared_ptr< http::EffectiveUrl > &  source_url,
bool  trusted 
)
inlineexplicit

Definition at line 95 of file EffectiveUrl.h.

◆ EffectiveUrl() [8/8]

http::EffectiveUrl::EffectiveUrl ( std::shared_ptr< http::url source_url)
inlineexplicit

Definition at line 101 of file EffectiveUrl.h.

◆ ~EffectiveUrl()

virtual http::EffectiveUrl::~EffectiveUrl ( )
inlinevirtual

Definition at line 109 of file EffectiveUrl.h.

Member Function Documentation

◆ dump()

string http::EffectiveUrl::dump ( )
overridevirtual

A string dump of the instance.

Returns
A string containing readable instance state.

Reimplemented from http::url.

Definition at line 139 of file EffectiveUrl.cc.

◆ get_header()

void http::EffectiveUrl::get_header ( const std::string &  name,
std::string &  value,
bool found 
)

get the value of the named header

Parameters
nameName of header value to retrieve
valueA return value parameter into which the value will be written.
foundA returned value parameter set to true if a value associated wit the header name is located, false otherwise.

Definition at line 119 of file EffectiveUrl.cc.

◆ host()

virtual std::string http::url::host ( ) const
inlinevirtualinherited

Definition at line 116 of file url_impl.h.

◆ ingest_response_headers()

void http::EffectiveUrl::ingest_response_headers ( const std::vector< std::string > &  resp_hdrs)

Ingests the passed response hedaers.

Parameters
resp_hdrsThe reponse headers to ingest.

Definition at line 160 of file EffectiveUrl.cc.

◆ ingest_time()

virtual std::time_t http::url::ingest_time ( ) const
inlinevirtualinherited

Definition at line 122 of file url_impl.h.

◆ is_expired()

bool http::EffectiveUrl::is_expired ( )
overridevirtual

Returns true if URL is reusable, false otherwise.

Returns
Returns true if the query string parameters or response headers received with the EffectiveUrl indicate that the URL may be reused. False otherwise

Reimplemented from http::url.

Definition at line 69 of file EffectiveUrl.cc.

◆ is_trusted()

virtual bool http::url::is_trusted ( )
inlinevirtualinherited

Definition at line 134 of file url_impl.h.

◆ path()

virtual std::string http::url::path ( ) const
inlinevirtualinherited

Definition at line 118 of file url_impl.h.

◆ protocol()

virtual std::string http::url::protocol ( ) const
inlinevirtualinherited

Definition at line 114 of file url_impl.h.

◆ query()

virtual std::string http::url::query ( ) const
inlinevirtualinherited

Definition at line 120 of file url_impl.h.

◆ query_parameter_value()

string http::url::query_parameter_value ( const std::string &  key) const
virtualinherited
Parameters
key
Returns

Definition at line 251 of file url_impl.cc.

◆ query_parameter_values()

void http::url::query_parameter_values ( const std::string &  key,
std::vector< std::string > &  values 
) const
virtualinherited
Parameters
key
values

Definition at line 270 of file url_impl.cc.

◆ set_ingest_time()

virtual void http::url::set_ingest_time ( const std::time_t &  itime)
inlinevirtualinherited

Definition at line 126 of file url_impl.h.

◆ str()

virtual std::string http::url::str ( ) const
inlinevirtualinherited

Definition at line 112 of file url_impl.h.


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