input_verify_checksum Class Reference

#include <verify_check.h>

Inheritance diagram for input_verify_checksum:

Public Member Functions
virtual	~input_verify_checksum ()
	input_verify_checksum (input &deeper, unsigned long checksum)
long	read_inner (void *data, size_t nbytes)
nstring	name ()
long	length ()
long	ftell_inner ()
bool	is_remote () const
Private Member Functions
	input_verify_checksum ()
	input_verify_checksum (const input_verify_checksum &)
input_verify_checksum &	operator= (const input_verify_checksum &)
Private Attributes
input	deeper
unsigned long	checksum_given
unsigned long	checksum_calculated
long	pos

---

Detailed Description

The input_verify_checksum class is used to represent an input filter which verifies the Adler 32 checksum of data that it reads.

Definition at line 29 of file verify_check.h.

---

Constructor & Destructor Documentation

virtual input_verify_checksum::~input_verify_checksum

(

)

[virtual]

The destructor.

input_verify_checksum::input_verify_checksum	(	input &	deeper,
		unsigned long	checksum
	)

The constructor.

Parameters:

	deeper	The source input stream that this filter uses to obtain its data.
	checksum

input_verify_checksum::input_verify_checksum

(

)

[private]

The default constructor. Do not use.

input_verify_checksum::input_verify_checksum

(

const input_verify_checksum &

)

[private]

The copy constructor. Do not use.

---

Member Function Documentation

long input_verify_checksum::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.

nstring input_verify_checksum::name

(

)

[virtual]

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

Implements input_ty.

long input_verify_checksum::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.

long input_verify_checksum::ftell_inner

(

)

[virtual]

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

Implements input_ty.

bool input_verify_checksum::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_verify_checksum& input_verify_checksum::operator=

(

const input_verify_checksum &

)

[private]

The assignment operator. Do not use.

---

Field Documentation

input input_verify_checksum::deeper [private]

The deeper instance variable is sued to remember the source input stream that this filter uses to obtain its data.

Definition at line 67 of file verify_check.h.

unsigned long input_verify_checksum::checksum_given [private]

The checksum_given instance variable is used to remember the checksum given to the constructor.

Definition at line 73 of file verify_check.h.

unsigned long input_verify_checksum::checksum_calculated [private]

The checksum_calculated instance variable is used to remember the running checksum calculated from the data.

Definition at line 79 of file verify_check.h.

long input_verify_checksum::pos [private]

The pos instance variable is used to remember the current file position.

Definition at line 85 of file verify_check.h.

---

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

• libaegis/input/verify_check.h