input_stdin Class Reference

#include <stdin.h>

Inheritance diagram for input_stdin:

input_ty

Public Member Functions

virtual ~input_stdin ()
 input_stdin ()
nstring name ()
long length ()
void keepalive ()
long read_inner (void *data, size_t nbytes)
long ftell_inner ()

Private Member Functions

 input_stdin (const input_stdin &arg)
input_stdinoperator= (const input_stdin &arg)

Private Attributes

long pos
bool unbuffered

Detailed Description

The input_stdin class is used to represent an input source which reads from the standard input.

Definition at line 29 of file stdin.h.


Constructor & Destructor Documentation

virtual input_stdin::~input_stdin (  )  [virtual]

The destructor.

input_stdin::input_stdin (  ) 

The default constructor.

input_stdin::input_stdin ( const input_stdin arg  )  [private]

The copy constructor. Do not use.


Member Function Documentation

nstring input_stdin::name (  )  [virtual]

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

Implements input_ty.

long input_stdin::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_stdin::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_stdin::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_stdin::ftell_inner (  )  [virtual]

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

Implements input_ty.

input_stdin& input_stdin::operator= ( const input_stdin arg  )  [private]

The default constructor. Do not use.


Field Documentation

long input_stdin::pos [private]

Definition at line 59 of file stdin.h.

bool input_stdin::unbuffered [private]

Definition at line 60 of file stdin.h.


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

Generated on Wed Mar 12 23:37:40 2008 for Aegis by  doxygen 1.5.5