code::RshReader Class Reference

Inheritance diagram for code::RshReader:

code::SchemeReader code::Reader List of all members.

Detailed Description

Reader that uses rsh to read across a network.

WARNING: this implementation is untested, as it seems that the previous RSH Reader code was abandoned and we've all got rsh turned off anyway.

Author:
Charles Kerr
Version:
Id
code_RshReader.h,v 1.2 2009/06/02 20:17:37 lakshman Exp


Public Member Functions

 RshReader ()
virtual ~RshReader ()
virtual int open (const URL &url)
virtual int read (Buffer &, long offset=0, size_t max_bytes=0)

Static Public Member Functions

static void introduce ()
static int read (const URL &url, Buffer &buffer, long offset=0, size_t max_len=0)
 Convenience function to read `url' into `buf'.
static int read (const URL &url, std::string &s, long offset=0, size_t max_len=0)
 Identical to read(const URL&,Buffer&,long,size_t) except it takes a string instead of a buffer.
static int readRaw (const URL &url, Buffer &b, long offset=0, size_t max_len=0)
 Identical to read() except except it doesn't uncompress files.
static SmartPtr< XML::DocumentreadXMLDocument (const URL &url)
 Returns an XML::Document created by passing the contents of `url' to XML::Parser::parse().
static SmartPtr< ReadergetReader (const URL &url)
 Returns a handle to a reader for the given URL.
static void introduceWDSSIIReaders ()


Constructor & Destructor Documentation

code::RshReader::RshReader (  ) 

virtual code::RshReader::~RshReader (  )  [virtual]


Member Function Documentation

static SmartPtr<Reader> code::Reader::getReader ( const URL url  )  [static, inherited]

Returns a handle to a reader for the given URL.

This is useful when you want to make iterative calls to read() or LineReader::readLine().

static void code::RshReader::introduce (  )  [static]

static void code::Reader::introduceWDSSIIReaders (  )  [static, inherited]

virtual int code::RshReader::open ( const URL url  )  [virtual]

Implements code::SchemeReader.

static int code::Reader::read ( const URL url,
std::string &  s,
long  offset = 0,
size_t  max_len = 0 
) [static, inherited]

Identical to read(const URL&,Buffer&,long,size_t) except it takes a string instead of a buffer.

static int code::Reader::read ( const URL url,
Buffer buffer,
long  offset = 0,
size_t  max_len = 0 
) [static, inherited]

Convenience function to read `url' into `buf'.

Handles remote, local, compressed, and uncompressed files transparently.

Parameters:
url the data source.
buffer where source's contents will be stored.
offset number of bytes to skip before read() begins storing.
max_len if nonzero, maximum number of bytes to store in buf.
Returns:
the number of bytes read, or a negative number on error.

virtual int code::RshReader::read ( Buffer ,
long  offset = 0,
size_t  max_bytes = 0 
) [virtual]

See also:
static int read (URL, Buffer, offset, long, size_t);

Implements code::Reader.

static int code::Reader::readRaw ( const URL url,
Buffer b,
long  offset = 0,
size_t  max_len = 0 
) [static, inherited]

Identical to read() except except it doesn't uncompress files.

This is useful when mirroring compressed files to avoid decompress / recompress steps.

static SmartPtr<XML::Document> code::Reader::readXMLDocument ( const URL url  )  [static, inherited]

Returns an XML::Document created by passing the contents of `url' to XML::Parser::parse().


Generated on Fri May 4 13:40:10 2012 for WDSS-IIw2 by  doxygen 1.4.7