#include <headerField.hpp>

Inheritance diagram for headerField:

[legend]

Collaboration diagram for headerField:

[legend]

Public Member Functions
	~headerField ()

shared_ptr< component >	clone () const

void	copyFrom (const component &other)

headerField &	operator= (const headerField &other)

const std::vector< shared_ptr< component > >	getChildComponents ()

void	setName (const string &name)

const string	getName () const

bool	isCustom () const

virtual shared_ptr< const headerFieldValue >	getValue () const

template<typename T >
shared_ptr< const T >	getValue () const

virtual shared_ptr< headerFieldValue >	getValue ()

template<typename T >
shared_ptr< T >	getValue ()

virtual void	setValue (shared_ptr< headerFieldValue > value)

virtual void	setValueConst (shared_ptr< const headerFieldValue > value)

virtual void	setValue (const headerFieldValue &value)

void	setValue (const string &value)

size_t	getGeneratedSize (const generationContext &ctx)

Public Member Functions inherited from component
	component ()

virtual	~component ()

void	parse (const string &buffer)

void	parse (const parsingContext &ctx, const string &buffer)

void	parse (shared_ptr< utility::inputStream > inputStream, const size_t length)

void	parse (const string &buffer, const size_t position, const size_t end, size_t *newPosition=NULL)

void	parse (const parsingContext &ctx, const string &buffer, const size_t position, const size_t end, size_t *newPosition=NULL)

void	parse (shared_ptr< utility::inputStream > inputStream, const size_t position, const size_t end, size_t *newPosition=NULL)

void	parse (const parsingContext &ctx, shared_ptr< utility::inputStream > inputStream, const size_t position, const size_t end, size_t *newPosition=NULL)

virtual const string	generate (const size_t maxLineLength=lineLengthLimits::infinite, const size_t curLinePos=0) const

virtual void	generate (utility::outputStream &outputStream, const size_t curLinePos=0, size_t *newLinePos=NULL) const

virtual void	generate (const generationContext &ctx, utility::outputStream &outputStream, const size_t curLinePos=0, size_t *newLinePos=NULL) const

size_t	getParsedOffset () const

size_t	getParsedLength () const

Static Public Member Functions
static shared_ptr< headerField >	parseNext (const parsingContext &ctx, const string &buffer, const size_t position, const size_t end, size_t *newPosition=NULL)

Protected Member Functions
	headerField ()

	headerField (const string &fieldName)

void	parseImpl (const parsingContext &ctx, const string &buffer, const size_t position, const size_t end, size_t *newPosition=NULL)

void	generateImpl (const generationContext &ctx, utility::outputStream &os, const size_t curLinePos=0, size_t *newLinePos=NULL) const

Protected Member Functions inherited from component
void	setParsedBounds (const size_t start, const size_t end)

virtual void	parseImpl (const parsingContext &ctx, shared_ptr< utility::parserInputStreamAdapter > parser, const size_t position, const size_t end, size_t *newPosition=NULL)

Protected Member Functions inherited from object
	object ()

	object (const object &)

object &	operator= (const object &)

virtual	~object ()

Protected Attributes
string	m_name

shared_ptr< headerFieldValue >	m_value

Detailed Description

Base class for header fields.

Constructor & Destructor Documentation

◆ headerField() [1/2]

headerField ( )

protected

◆ headerField() [2/2]

headerField ( const string & fieldName )

protected

◆ ~headerField()

~headerField ( )

Member Function Documentation

◆ clone()

shared_ptr< component > clone ( ) const

virtual

Clone this component.

Returns: a copy of this component

Implements component.

References vmime::dynamicCast(), headerFieldFactory::getInstance(), and headerField::m_name.

◆ copyFrom()

void copyFrom ( const component & other )

virtual

Replace data in this component by data in other component.

Both components must be of the same type.

Exceptions

std::bad_cast_exception if the components are not of the same (dynamic) type

Parameters

other other component to copy data from

Implements component.

Reimplemented in parameterizedHeaderField.

References headerField::copyFrom(), vmime::dynamicCast(), and headerField::m_value.

Referenced by headerField::copyFrom(), parameterizedHeaderField::copyFrom(), and headerField::operator=().

◆ generateImpl()

void generateImpl	(	const generationContext &	ctx,
		utility::outputStream &	os,
		const size_t	curLinePos = `0`,
		size_t *	newLinePos = `NULL`
	)		const

protectedvirtual

Implements component.

Reimplemented in parameterizedHeaderField.

References vmime::dynamicCast(), headerField::m_name, and headerField::m_value.

Referenced by parameterizedHeaderField::generateImpl().

◆ getChildComponents()

const std::vector< shared_ptr< component > > getChildComponents ( )

virtual

Return the list of children of this component.

Returns: list of child components

Implements component.

Reimplemented in parameterizedHeaderField.

References headerField::m_value.

Referenced by parameterizedHeaderField::getChildComponents().

◆ getGeneratedSize()

size_t getGeneratedSize ( const generationContext & ctx )

virtual

Get the number of bytes that will be used by this component when it is generated.

This may be a heuristically-derived estimate, but such an estimated size should always be larger than the actual generated size.

Parameters

ctx	generation context

Returns: component size when generated

Reimplemented from component.

Reimplemented in parameterizedHeaderField.

References vmime::dynamicCast(), headerField::m_name, and headerField::m_value.

Referenced by parameterizedHeaderField::getGeneratedSize().

◆ getName()

const string getName ( ) const

Return the name of this field.

Returns: field name

References headerField::m_name.

Referenced by headerField::setValue(), headerField::setValue(), and headerField::setValueConst().

◆ getValue() [1/4]

shared_ptr< headerFieldValue > getValue ( )

virtual

Return the value object attached to this field.

Returns: value object

References headerField::m_value.

◆ getValue() [2/4]

template<typename T >

shared_ptr< T > getValue ( )

Return the value object attached to this field, casted to the specified type.

Returns: value object

References vmime::dynamicCast().

◆ getValue() [3/4]

shared_ptr< const headerFieldValue > getValue ( ) const

virtual

Return the read-only value object attached to this field.

Returns: read-only value object

References headerField::m_value.

Referenced by body::getContentType(), and parameterizedHeaderField::parseImpl().

◆ getValue() [4/4]

template<typename T >

shared_ptr< const T > getValue ( ) const

Return the read-only value object attached to this field, casted to the specified type.

Returns: value object

References vmime::dynamicCast().

◆ isCustom()

bool isCustom ( ) const

Check whether this field is a custom (non-standard) field.

Custom fields have a name beginning with "X-".

Returns: true if the field is a custom field, false otherwise

References headerField::m_name.

◆ operator=()

headerField & operator= ( const headerField & other )

References headerField::copyFrom().

◆ parseImpl()

void parseImpl	(	const parsingContext &	ctx,
		const string &	buffer,
		const size_t	position,
		const size_t	end,
		size_t *	newPosition = `NULL`
	)

protectedvirtual

Reimplemented from component.

Reimplemented in parameterizedHeaderField.

References vmime::dynamicCast(), vmime::end(), and headerField::m_value.

◆ parseNext()

shared_ptr< headerField > parseNext	(	const parsingContext &	ctx,
		const string &	buffer,
		const size_t	position,
		const size_t	end,
		size_t *	newPosition = `NULL`
	)

static

Parse a header field from a buffer.

Parameters

ctx	parsing context
buffer	input buffer
position	current position in the input buffer
end	end position in the input buffer
newPosition	will receive the new position in the input buffer

Returns: parsed header field, or NULL if no more header field can be parsed in the input buffer

References vmime::dynamicCast(), vmime::end(), parserHelpers::findEOL(), headerFieldFactory::getInstance(), and parserHelpers::isSpace().

Referenced by header::parseImpl().

◆ setName()

void setName ( const string & name )

Sets the name of this field.

Parameters

name	field name (eg: "From" or "X-MyField").

References headerField::m_name.

◆ setValue() [1/3]

void setValue ( const headerFieldValue & value )

virtual

Set the value of this field (reference version).

The value will be cloned.

Exceptions

exceptions::bad_field_value_type if the value type is not valid for this header field

Parameters

value new value

References vmime::clone(), vmime::dynamicCast(), headerFieldFactory::getInstance(), headerField::getName(), and headerField::m_value.

◆ setValue() [2/3]

void setValue ( const string & value )

Set the value of this field given a character string.

Parameters

value value string to parse

References vmime::dynamicCast(), and component::parse().

◆ setValue() [3/3]

void setValue ( shared_ptr< headerFieldValue > value )

virtual

Set the value of this field.

Exceptions

exceptions::bad_field_value_type if the value type is not valid for this header field

Parameters

value new value

References vmime::dynamicCast(), headerFieldFactory::getInstance(), headerField::getName(), and headerField::m_value.

◆ setValueConst()

void setValueConst ( shared_ptr< const headerFieldValue > value )

virtual

Set the value of this field by cloning the specified value.

Exceptions

exceptions::bad_field_value_type if the value type is not valid for this header field

Parameters

value new value

References vmime::clone(), vmime::dynamicCast(), headerFieldFactory::getInstance(), headerField::getName(), and headerField::m_value.

Member Data Documentation

◆ m_name

string m_name

protected

Referenced by headerField::clone(), headerField::generateImpl(), headerField::getGeneratedSize(), headerField::getName(), headerField::isCustom(), and headerField::setName().

◆ m_value

shared_ptr<headerFieldValue> m_value

protected

Referenced by headerField::copyFrom(), headerField::generateImpl(), headerField::getChildComponents(), headerField::getGeneratedSize(), headerField::getValue(), headerField::getValue(), headerField::parseImpl(), headerField::setValue(), headerField::setValue(), and headerField::setValueConst().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ headerField() [1/2]

◆ headerField() [2/2]

◆ ~headerField()

Member Function Documentation

◆ clone()

◆ copyFrom()

◆ generateImpl()

◆ getChildComponents()

◆ getGeneratedSize()

◆ getName()

◆ getValue() [1/4]

◆ getValue() [2/4]

◆ getValue() [3/4]

◆ getValue() [4/4]

◆ isCustom()

◆ operator=()

◆ parseImpl()

◆ parseNext()

◆ setName()

◆ setValue() [1/3]

◆ setValue() [2/3]

◆ setValue() [3/3]

◆ setValueConst()

Member Data Documentation

◆ m_name

◆ m_value