input_catenate Class Reference

#include <catenate.h>

Inheritance diagram for input_catenate:

Public Member Functions
virtual	~input_catenate ()
	input_catenate (input deeper[], size_t ndeeper, bool close_on_close)
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_catenate ()
	input_catenate (const input_catenate &arg)
input_catenate &	operator= (const input_catenate &arg)
Private Attributes
input *	deeper
size_t	ndeeper
bool	delete_on_close
size_t	selector
size_t	pos

---

Detailed Description

Definition at line 25 of file catenate.h.

---

Constructor & Destructor Documentation

virtual input_catenate::~input_catenate

(

)

[virtual]

The destructor.

input_catenate::input_catenate	(	input	deeper[],
		size_t	ndeeper,
		bool	close_on_close
	)

The constructor.

input_catenate::input_catenate

(

)

[private]

The default constructor. Do not use.

input_catenate::input_catenate

(

const input_catenate &

arg

)

[private]

The copy constructor. Do not use.

---

Member Function Documentation

nstring input_catenate::name

(

)

[virtual]

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

Implements input_ty.

long input_catenate::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_catenate::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_catenate::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_catenate::ftell_inner

(

)

[virtual]

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

Implements input_ty.

bool input_catenate::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_catenate& input_catenate::operator=

(

const input_catenate &

arg

)

[private]

The assignment operator. Do not use.

---

Field Documentation

input* input_catenate::deeper [private]

Definition at line 58 of file catenate.h.

size_t input_catenate::ndeeper [private]

Definition at line 59 of file catenate.h.

bool input_catenate::delete_on_close [private]

Definition at line 60 of file catenate.h.

size_t input_catenate::selector [private]

Definition at line 61 of file catenate.h.

size_t input_catenate::pos [private]

Definition at line 62 of file catenate.h.

---

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

• libaegis/input/catenate.h