input_822wrap Class Reference

#include <822wrap.h>

Inheritance diagram for input_822wrap:

Public Member Functions
virtual	~input_822wrap ()
	input_822wrap (input &deeper)
nstring	name ()
long	length ()
void	keepalive ()
long	read_inner (void *data, size_t nbytes)
long	ftell_inner ()
bool	is_remote () const
Private Member Functions
	input_822wrap ()
	input_822wrap (const input_822wrap &arg)
input_822wrap &	operator= (const input_822wrap &arg)
Private Attributes
input &	deeper
long	pos
int	column

---

Detailed Description

The input_822wrap class may be used to transparently join continuation lines when reading rfc822 headers.

Definition at line 29 of file 822wrap.h.

---

Constructor & Destructor Documentation

virtual input_822wrap::~input_822wrap

(

)

[virtual]

The destructor.

input_822wrap::input_822wrap

(

input &

deeper

)

The constructor.

input_822wrap::input_822wrap

(

)

[private]

The default constructor. Do not use.

input_822wrap::input_822wrap

(

const input_822wrap &

arg

)

[private]

The copy constructor. Do not use.

---

Member Function Documentation

nstring input_822wrap::name

(

)

[virtual]

The name method is used to determine the name of the input.

Implements input_ty.

long input_822wrap::length

(

)

[virtual]

The length method is used to determine the length of the input. May return -1 if the length is unknown.

Implements input_ty.

void input_822wrap::keepalive

(

)

[virtual]

The keepalive method is used to set the SO_KEEPALIVE socket option, if the file is a socket. Does nothing otherwise.

Reimplemented from input_ty.

long input_822wrap::read_inner	(	void *	data,
		size_t	nbytes
	)			[virtual]

The read_inner method is used to read unbuffered data from the given input stream. At most nbytes bytes will be read into data. The number of bytes actually read will be returned. At end-of-file, a value <= 0 will be returned, and data will be unchanged. All file read errors or format errors are fatal, and will cause the method to not return.

Parameters:

	data	Where to put the results of the read.
	nbytes	The maximum number of bytes to read.

Returns:

The actual number of bytes read, or zero for end-of-file.

Implements input_ty.

long input_822wrap::ftell_inner

(

)

[virtual]

The ftell_inner method is used to determine the unbuffered current position within the input.

Implements input_ty.

bool input_822wrap::is_remote

(

)

const [virtual]

The is_remote method is used to determine whether or not an input stream is from a local file or a remote source. This is only intended to be a generally informative thing, to provide information to the user, it isn't (and can't be) utterly precise.

Reimplemented from input_ty.

input_822wrap& input_822wrap::operator=

(

const input_822wrap &

arg

)

[private]

The assignment operator. Do not use.

---

Field Documentation

input& input_822wrap::deeper [private]

The deeper instance variable is used to remember the data source for this filter.

Definition at line 66 of file 822wrap.h.

long input_822wrap::pos [private]

The pos instance variable is used to remember the byte position withing this input stream.

Definition at line 72 of file 822wrap.h.

int input_822wrap::column [private]

The column instance variable is used to remember the current column of the cursor position. Zero based.

Definition at line 78 of file 822wrap.h.

---

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

• libaegis/input/822wrap.h