NCBI C++ ToolKit
Public Types | Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members

Search Toolkit Book for CUrl

CUrl –. More...

#include <corelib/ncbi_url.hpp>

+ Inheritance diagram for CUrl:
+ Collaboration diagram for CUrl:

Public Types

enum  EAdjustFlags {
  fUser_Replace = 0x0001 , fUser_ReplaceIfEmpty = 0x0002 , fPassword_Replace = 0x0004 , fPassword_ReplaceIfEmpty = 0x0008 ,
  fPath_Replace = 0x0010 , fPath_Append = 0x0020 , fFragment_Replace = 0x0040 , fFragment_ReplaceIfEmpty = 0x0080 ,
  fArgs_Replace = 0x0100 , fArgs_Append = 0x0200 , fArgs_Merge = 0x0400 , fScheme_Replace = 0x0800
}
 Flags controlling URL adjustment. More...
 
typedef int TAdjustFlags
 
- Public Types inherited from CUrl_Base
enum class  E_memberIndex {
  e__allMandatory = 0 , e_Attlist , e_Url , e__allMandatory = 0 ,
  e_Attlist , e_Url
}
 
enum class  E_memberIndex {
  e__allMandatory = 0 , e_Attlist , e_Url , e__allMandatory = 0 ,
  e_Attlist , e_Url
}
 
typedef C_Attlist TAttlist
 
typedef NCBI_NS_STD::string TUrl
 
typedef Tparent::CMemberIndex< E_memberIndex, 3 > TmemberIndex
 
typedef C_Attlist TAttlist
 
typedef NCBI_NS_STD::string TUrl
 
typedef Tparent::CMemberIndex< E_memberIndex, 3 > TmemberIndex
 

Public Member Functions

 CUrl (void)
 Default constructor. More...
 
 CUrl (const string &url, const IUrlEncoder *encoder=0)
 Parse the URL. More...
 
 CUrl (const char *url, const IUrlEncoder *encoder=0)
 
void SetUrl (const string &url, const IUrlEncoder *encoder=0)
 Parse the URL. More...
 
string ComposeUrl (CUrlArgs::EAmpEncoding amp_enc, const IUrlEncoder *encoder=0) const
 Compose the URL. More...
 
const stringGetScheme (void) const
 
void SetScheme (const string &value)
 
bool GetIsGeneric (void) const
 Generic schemes use '//' prefix (after optional scheme). More...
 
void SetIsGeneric (bool value)
 
const stringGetUser (void) const
 
void SetUser (const string &value)
 
const stringGetPassword (void) const
 
void SetPassword (const string &value)
 
const stringGetHost (void) const
 
void SetHost (const string &value)
 
bool IsService (void) const
 
const stringGetService (void) const
 
void SetService (const string &value)
 
const stringGetPort (void) const
 
void SetPort (const string &value)
 
const stringGetPath (void) const
 
void SetPath (const string &value)
 
const stringGetFragment (void) const
 
void SetFragment (const string &value)
 
const stringGetOriginalArgsString (void) const
 Get the original (unparsed and undecoded) query string. More...
 
bool HaveArgs (void) const
 Check if the URL contains any arguments. More...
 
const CUrlArgsGetArgs (void) const
 Get const list of arguments. More...
 
CUrlArgsGetArgs (void)
 Get list of arguments. More...
 
 CUrl (const CUrl &url)
 
CUrloperator= (const CUrl &url)
 
bool IsEmpty (void) const
 
void Adjust (const CUrl &other, TAdjustFlags flags)
 Adjust this URL using information from 'other' URL. More...
 
 CUrl (void)
 
 CUrl (const std::string &value)
 
 ~CUrl (void)
 
 operator const TUrl & (void) const
 Conversion operator to 'TUrl' type. More...
 
CUrloperator= (const TUrl &value)
 Assignment operator. More...
 
 CUrl (void)
 
 CUrl (const std::string &value)
 
 ~CUrl (void)
 
 operator const TUrl & (void) const
 Conversion operator to 'TUrl' type. More...
 
CUrloperator= (const TUrl &value)
 Assignment operator. More...
 
- Public Member Functions inherited from CUrl_Base
 CUrl_Base (void)
 
virtual ~CUrl_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetAttlist (void) const
 Check if a value has been assigned to Attlist data member. More...
 
bool CanGetAttlist (void) const
 Check if it is safe to call GetAttlist method. More...
 
void ResetAttlist (void)
 Reset Attlist data member. More...
 
const TAttlistGetAttlist (void) const
 Get the Attlist member data. More...
 
void SetAttlist (TAttlist &value)
 Assign a value to Attlist data member. More...
 
TAttlistSetAttlist (void)
 Assign a value to Attlist data member. More...
 
bool IsSetUrl (void) const
 Check if a value has been assigned to Url data member. More...
 
bool CanGetUrl (void) const
 Check if it is safe to call GetUrl method. More...
 
void ResetUrl (void)
 Reset Url data member. More...
 
const TUrlGetUrl (void) const
 Get the Url member data. More...
 
void SetUrl (const TUrl &value)
 Assign a value to Url data member. More...
 
void SetUrl (TUrl &&value)
 
TUrlSetUrl (void)
 Assign a value to Url data member. More...
 
virtual void Reset (void)
 Reset the whole object. More...
 
 CUrl_Base (void)
 
virtual ~CUrl_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetAttlist (void) const
 Check if a value has been assigned to Attlist data member. More...
 
bool CanGetAttlist (void) const
 Check if it is safe to call GetAttlist method. More...
 
void ResetAttlist (void)
 Reset Attlist data member. More...
 
const TAttlistGetAttlist (void) const
 Get the Attlist member data. More...
 
void SetAttlist (TAttlist &value)
 Assign a value to Attlist data member. More...
 
TAttlistSetAttlist (void)
 Assign a value to Attlist data member. More...
 
bool IsSetUrl (void) const
 Check if a value has been assigned to Url data member. More...
 
bool CanGetUrl (void) const
 Check if it is safe to call GetUrl method. More...
 
void ResetUrl (void)
 Reset Url data member. More...
 
const TUrlGetUrl (void) const
 Get the Url member data. More...
 
void SetUrl (const TUrl &value)
 Assign a value to Url data member. More...
 
void SetUrl (TUrl &&value)
 
TUrlSetUrl (void)
 Assign a value to Url data member. More...
 
virtual void Reset (void)
 Reset the whole object. More...
 

Static Public Member Functions

static IUrlEncoderGetDefaultEncoder (void)
 Return default URL encoder. More...
 

Private Types

typedef CUrl_Base Tparent
 
typedef CUrl_Base Tparent
 

Private Member Functions

void x_SetScheme (const string &scheme, const IUrlEncoder &encoder)
 
void x_SetUser (const string &user, const IUrlEncoder &encoder)
 
void x_SetPassword (const string &password, const IUrlEncoder &encoder)
 
void x_SetHost (const string &host, const IUrlEncoder &encoder)
 
void x_SetService (const string &service)
 
void x_SetPort (const string &port, const IUrlEncoder &encoder)
 
void x_SetPath (const string &path, const IUrlEncoder &encoder)
 
void x_SetArgs (const string &args, const IUrlEncoder &encoder)
 
void x_SetFragment (const string &fragment, const IUrlEncoder &encoder)
 
bool x_IsHostPort (const string &scheme, string &unparsed, const IUrlEncoder &encoder)
 
 CUrl (const CUrl &value)
 
CUrloperator= (const CUrl &value)
 
 CUrl (const CUrl &value)
 
CUrloperator= (const CUrl &value)
 

Private Attributes

string m_Scheme
 
bool m_IsGeneric
 
string m_User
 
string m_Password
 
string m_Host
 
string m_Service
 
string m_Port
 
string m_Path
 
string m_Fragment
 
string m_OrigArgs
 
unique_ptr< CUrlArgsm_ArgsList
 

Detailed Description

CUrl –.

Definition at line 352 of file ncbi_url.hpp.


The documentation for this class was generated from the following files:
Modified on Sat May 25 14:20:49 2024 by modify_doxy.py rev. 669887