bes  Updated for version 3.20.8
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. More...
 
 EffectiveUrl (const std::string &url_s)
 
 EffectiveUrl (const std::string &url_s, const std::vector< std::string > &resp_hdrs)
 
void get_header (const std::string &name, std::string &value, bool &found)
 get the value of the named header More...
 
virtual std::string host () const
 
void ingest_response_headers (const std::vector< std::string > &resp_hdrs)
 Ingests the passed response hedaers. More...
 
virtual time_t ingest_time () const
 
bool is_expired () override
 Returns true if URL is reusable, false otherwise. More...
 
void parse (const std::string &source_url)
 
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 time_t itime)
 
virtual std::string str () const
 
void url (std::string url)
 

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 43 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 135 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 115 of file EffectiveUrl.cc.

◆ 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 156 of file EffectiveUrl.cc.

◆ 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 67 of file EffectiveUrl.cc.

◆ parse()

void http::url::parse ( const std::string &  source_url)
inherited

Tip of the hat to: https://stackoverflow.com/questions/2616011/easy-way-to-parse-a-url-in-c-cross-platform

Parameters
source_url

Definition at line 145 of file url_impl.cc.

◆ query_parameter_value()

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

Definition at line 201 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 220 of file url_impl.cc.


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