apt_text_message.h File Reference

Text Message Interface (RFC5322). More...

#include "apt_header_field.h"
#include "apt_text_stream.h"

Go to the source code of this file.

Data Structures
struct	apt_message_context_t
struct	apt_message_parser_vtable_t
struct	apt_message_generator_vtable_t
Typedefs
typedef struct apt_message_parser_t	apt_message_parser_t
typedef struct apt_message_parser_vtable_t	apt_message_parser_vtable_t
typedef struct apt_message_generator_t	apt_message_generator_t
typedef struct apt_message_generator_vtable_t	apt_message_generator_vtable_t
typedef struct apt_message_context_t	apt_message_context_t
Enumerations
enum	apt_message_status_e { APT_MESSAGE_STATUS_COMPLETE, APT_MESSAGE_STATUS_INCOMPLETE, APT_MESSAGE_STATUS_INVALID }
Functions
apt_message_parser_t *	apt_message_parser_create (void *obj, const apt_message_parser_vtable_t *vtable, apr_pool_t *pool)
apt_message_status_e	apt_message_parser_run (apt_message_parser_t *parser, apt_text_stream_t *stream, void **message)
void *	apt_message_parser_object_get (apt_message_parser_t *parser)
void	apt_message_parser_verbose_set (apt_message_parser_t *parser, apt_bool_t verbose)
apt_message_generator_t *	apt_message_generator_create (void *obj, const apt_message_generator_vtable_t *vtable, apr_pool_t *pool)
apt_message_status_e	apt_message_generator_run (apt_message_generator_t *generator, void *message, apt_text_stream_t *stream)
void *	apt_message_generator_object_get (apt_message_generator_t *generator)
void	apt_message_generator_verbose_set (apt_message_generator_t *generator, apt_bool_t verbose)
apt_header_field_t *	apt_header_field_parse (apt_text_stream_t *stream, apr_pool_t *pool)
apt_bool_t	apt_header_field_generate (const apt_header_field_t *header_field, apt_text_stream_t *stream)
apt_bool_t	apt_header_section_parse (apt_header_section_t *header, apt_text_stream_t *stream, apr_pool_t *pool)
apt_bool_t	apt_header_section_generate (const apt_header_section_t *header, apt_text_stream_t *stream)

---

Detailed Description

Text Message Interface (RFC5322).

---

Typedef Documentation

typedef struct apt_message_context_t apt_message_context_t

Temporary context associated with message and used for its parsing or generation

typedef struct apt_message_generator_t apt_message_generator_t

Opaque text message generator

typedef struct apt_message_generator_vtable_t apt_message_generator_vtable_t

Vtable of text message generator

typedef struct apt_message_parser_t apt_message_parser_t

Opaque text message parser

typedef struct apt_message_parser_vtable_t apt_message_parser_vtable_t

Vtable of text message parser

---

Enumeration Type Documentation

enum apt_message_status_e

Status of text message processing (parsing/generation)

---

Function Documentation

apt_bool_t apt_header_field_generate	(	const apt_header_field_t *	header_field,
		apt_text_stream_t *	stream
	)

Generate individual header field (name-value pair)

apt_header_field_t* apt_header_field_parse	(	apt_text_stream_t *	stream,
		apr_pool_t *	pool
	)

Parse individual header field (name-value pair)

apt_bool_t apt_header_section_generate	(	const apt_header_section_t *	header,
		apt_text_stream_t *	stream
	)

Generate header section

apt_bool_t apt_header_section_parse	(	apt_header_section_t *	header,
		apt_text_stream_t *	stream,
		apr_pool_t *	pool
	)

Parse header section

apt_message_generator_t* apt_message_generator_create	(	void *	obj,
		const apt_message_generator_vtable_t *	vtable,
		apr_pool_t *	pool
	)

Create message generator

void* apt_message_generator_object_get

(

apt_message_generator_t *

generator

)

Get external object associated with generator

apt_message_status_e apt_message_generator_run	(	apt_message_generator_t *	generator,
		void *	message,
		apt_text_stream_t *	stream
	)

Generate message

void apt_message_generator_verbose_set	(	apt_message_generator_t *	generator,
		apt_bool_t	verbose
	)

Set verbose mode for the parser

apt_message_parser_t* apt_message_parser_create	(	void *	obj,
		const apt_message_parser_vtable_t *	vtable,
		apr_pool_t *	pool
	)

Create message parser

void* apt_message_parser_object_get

(

apt_message_parser_t *

parser

)

Get external object associated with parser

apt_message_status_e apt_message_parser_run	(	apt_message_parser_t *	parser,
		apt_text_stream_t *	stream,
		void **	message
	)

Parse message by raising corresponding event handlers

void apt_message_parser_verbose_set	(	apt_message_parser_t *	parser,
		apt_bool_t	verbose
	)

Set verbose mode for the parser