POST request data. More...

#include <connect/ncbi_http_session.hpp>

Inheritance diagram for CHttpFormData:

Collaboration diagram for CHttpFormData:

Classes
struct	SFormData

Public Types
enum	EContentType { eFormUrlEncoded , eMultipartFormData }
	Supported content types for POST requests. 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< Uint8 >	TCounter
	Counter type is CAtomiCounter. More...

typedef Uint8	TCount
	Alias for value type of counter. More...

Public Member Functions
void	AddEntry (CTempString entry_name, CTempString value, CTempString content_type=CTempString())
	Add name=value pair. More...

void	AddFile (CTempString entry_name, CTempString file_name, CTempString content_type=CTempString())
	Add file entry. More...

void	AddProvider (CTempString entry_name, CFormDataProvider_Base *provider)
	Add custom data provider. More...

bool	IsEmpty (void) const
	Check if the form data is empty (no entries have been added). More...

void	Clear (void)
	Clear all form data, reset content type to the default eFormUrlEncoded. More...

void	WriteFormData (CNcbiOstream &out) const
	Write form data to the stream using the selected form content type. More...

EContentType	GetContentType (void) const
	Get current content type. More...

void	SetContentType (EContentType content_type)
	Set content type for the form data. More...

virtual	~CHttpFormData (void)

string	GetContentTypeStr (void) const
	Get the form content type as a string. More...

Public Member Functions inherited from CObject
	CObject (void)
	Constructor. More...

	CObject (const CObject &src)
	Copy constructor. More...

virtual	~CObject (void)
	Destructor. More...

CObject &	operator= (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

Static Public Member Functions
static string	CreateBoundary (void)
	Generate a new random string to be used as multipart boundary. More...

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)

Private Types
typedef vector< SFormData >	TValues

typedef map< string, TValues >	TEntries

typedef vector< CRef< CFormDataProvider_Base > >	TProviders

typedef map< string, TProviders >	TProviderEntries

Private Member Functions
	CHttpFormData (void)

	CHttpFormData (const CHttpFormData &)

CHttpFormData &	operator= (const CHttpFormData &)

Private Attributes
EContentType	m_ContentType

TEntries	m_Entries

TProviderEntries	m_Providers

string	m_Boundary

Friends
class	CHttpRequest

Additional Inherited Members
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...

Detailed Description

POST request data.

Definition at line 355 of file ncbi_http_session.hpp.

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

include/connect/ncbi_http_session.hpp
src/connect/ncbi_http_session.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description