NCBI C++ ToolKit
Public Types | Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
CHttpSession_Base Class Referenceabstract

Search Toolkit Book for CHttpSession_Base

HTTP session class, holding common data for multiple requests. More...

#include <connect/ncbi_http_session.hpp>

+ Inheritance diagram for CHttpSession_Base:
+ Collaboration diagram for CHttpSession_Base:

Public Types

enum  ERequestMethod {
  eHead = eReqMethod_Head , eGet = eReqMethod_Get , ePost = eReqMethod_Post , ePut = eReqMethod_Put ,
  ePatch = eReqMethod_Patch , eDelete = eReqMethod_Delete
}
 Supported request methods, proxy for EReqMethod. More...
 
enum  EProtocol { eHTTP_10 , eHTTP_11 , eHTTP_2 }
 HTTP protocol version. More...
 
- Public Types inherited from CObject
enum  EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern }
 Control filling of newly allocated memory. More...
 
typedef CObjectCounterLocker TLockerType
 Default locker type for CRef. More...
 
typedef atomic< Uint8TCounter
 Counter type is CAtomiCounter. More...
 
typedef Uint8 TCount
 Alias for value type of counter. More...
 

Public Member Functions

CHttpRequest NewRequest (const CUrl &url, ERequestMethod method=eGet, const CHttpParam &param={})
 Initialize request. More...
 
CHttpResponse Get (const CUrl &url, const CTimeout &timeout=CTimeout(CTimeout::eDefault), THttpRetries retries=null)
 Shortcut for GET requests. More...
 
CHttpResponse Post (const CUrl &url, CTempString data, CTempString content_type=CTempString(), const CTimeout &timeout=CTimeout(CTimeout::eDefault), THttpRetries retries=null)
 Shortcut for POST requests. More...
 
CHttpResponse Put (const CUrl &url, CTempString data, CTempString content_type=CTempString(), const CTimeout &timeout=CTimeout(CTimeout::eDefault), THttpRetries retries=null)
 Shortcut for PUT requests. More...
 
const CHttpCookiesCookies (void) const
 Get all stored cookies. More...
 
CHttpCookiesCookies (void)
 Get all stored cookies, non-const. More...
 
EProtocol GetProtocol (void) const
 Get protocol version. More...
 
void SetProtocol (EProtocol protocol)
 
THTTP_Flags GetHttpFlags (void) const
 Get flags passed to CConn_HttpStream. More...
 
void SetHttpFlags (THTTP_Flags flags)
 Set flags passed to CConn_HttpStream. More...
 
void SetCredentials (shared_ptr< CTlsCertCredentials > cred)
 Set TLS credentials. More...
 
shared_ptr< CTlsCertCredentialsGetCredentials (void) const
 
 CHttpSession_Base (EProtocol protocol)
 
virtual ~CHttpSession_Base (void)
 
void SetProxy (const CHttpProxy &proxy)
 
const CHttpProxyGetProxy (void) const
 
- Public Member Functions inherited from CObject
 CObject (void)
 Constructor. More...
 
 CObject (const CObject &src)
 Copy constructor. More...
 
virtual ~CObject (void)
 Destructor. More...
 
CObjectoperator= (const CObject &src) THROWS_NONE
 Assignment operator. More...
 
bool CanBeDeleted (void) const THROWS_NONE
 Check if object can be deleted. More...
 
bool IsAllocatedInPool (void) const THROWS_NONE
 Check if object is allocated in memory pool (not system heap) More...
 
bool Referenced (void) const THROWS_NONE
 Check if object is referenced. More...
 
bool ReferencedOnlyOnce (void) const THROWS_NONE
 Check if object is referenced only once. More...
 
void AddReference (void) const
 Add reference to object. More...
 
void RemoveReference (void) const
 Remove reference to object. More...
 
void ReleaseReference (void) const
 Remove reference without deleting object. More...
 
virtual void DoNotDeleteThisObject (void)
 Mark this object as not allocated in heap – do not delete this object. More...
 
virtual void DoDeleteThisObject (void)
 Mark this object as allocated in heap – object can be deleted. More...
 
void * operator new (size_t size)
 Define new operator for memory allocation. More...
 
void * operator new[] (size_t size)
 Define new[] operator for 'array' memory allocation. More...
 
void operator delete (void *ptr)
 Define delete operator for memory deallocation. More...
 
void operator delete[] (void *ptr)
 Define delete[] operator for memory deallocation. More...
 
void * operator new (size_t size, void *place)
 Define new operator. More...
 
void operator delete (void *ptr, void *place)
 Define delete operator. More...
 
void * operator new (size_t size, CObjectMemoryPool *place)
 Define new operator using memory pool. More...
 
void operator delete (void *ptr, CObjectMemoryPool *place)
 Define delete operator. More...
 
virtual void DebugDump (CDebugDumpContext ddc, unsigned int depth) const
 Define method for dumping debug information. More...
 
- Public Member Functions inherited from CDebugDumpable
 CDebugDumpable (void)
 
virtual ~CDebugDumpable (void)
 
void DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const
 
void DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const
 
void DumpToConsole (void) const
 

Private Member Functions

virtual void x_StartRequest (EProtocol protocol, CHttpRequest &req, bool use_form_data)=0
 
virtual bool x_Downgrade (CHttpResponse &resp, EProtocol &protocol) const =0
 
void x_SetCookies (const CHttpHeaders::THeaderValues &cookies, const CUrl *url)
 
string x_GetCookies (const CUrl &url) const
 

Private Attributes

EProtocol m_Protocol
 
THTTP_Flags m_HttpFlags
 
CHttpCookies m_Cookies
 
shared_ptr< CTlsCertCredentialsm_Credentials
 
CHttpProxy m_Proxy
 

Friends

class CHttpRequest
 
class CHttpResponse
 

Additional Inherited Members

- Static Public Member Functions inherited from CObject
static NCBI_XNCBI_EXPORT void ThrowNullPointerException (void)
 Define method to throw null pointer exception. More...
 
static NCBI_XNCBI_EXPORT void ThrowNullPointerException (const type_info &type)
 
static EAllocFillMode GetAllocFillMode (void)
 
static void SetAllocFillMode (EAllocFillMode mode)
 
static void SetAllocFillMode (const string &value)
 Set mode from configuration parameter value. More...
 
- Static Public Member Functions inherited from CDebugDumpable
static void EnableDebugDump (bool on)
 
- Static Public Attributes inherited from CObject
static const TCount eCounterBitsCanBeDeleted = 1 << 0
 Define possible object states. More...
 
static const TCount eCounterBitsInPlainHeap = 1 << 1
 Heap signature was found. More...
 
static const TCount eCounterBitsPlaceMask
 Mask for 'in heap' state flags. More...
 
static const int eCounterStep = 1 << 2
 Skip over the "in heap" bits. More...
 
static const TCount eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2)
 Minimal value for valid objects (reference counter is zero) Must be a single bit value. More...
 
static const TCount eCounterStateMask
 Valid object, and object in heap. More...
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 
- Protected Member Functions inherited from CConnIniter
 CConnIniter (void)
 

Detailed Description

HTTP session class, holding common data for multiple requests.

Definition at line 697 of file ncbi_http_session.hpp.


The documentation for this class was generated from the following files:
Modified on Tue Apr 23 07:40:07 2024 by modify_doxy.py rev. 669887