class AkentiInputStream

An AkentiInputStream is used to deserialize objects from an ASCI string that was written using the conventions defined in AkentiOutputStream

Public Methods

AkentiInputStream (istream& is)
Constructs this AkentiInputStream given a reference to an input stream specified by is
~AkentiInputStream ()
Destructor
AkentiInputStream& operator>> (char& c)
Reads a char from the underlying input stream
AkentiInputStream& operator>> (int& n)
Reads a int from the underlying input stream
AkentiInputStream& operator>> (bool& b)
Reads a bool from the underlying input stream
AkentiInputStream& operator>> (long& l)
Reads a long from the underlying input stream
AkentiInputStream& operator>> (double& d)
Reads a double from the underlying input stream
char get ()
Reads one char using the istream::get method from the underlying input stream
AkentiInputStream& read (char* buffer, int len)
Reads len chararacters from the underlying input stream into the buffer specified by buffer
AkentiInputStream& operator>> (string& s)
Reads a string from the underlying input stream
AkentiInputStream& operator>> (UtcTime& utcTime)
Reads a UtcTime from the underlying input stream
AkentiInputStream& operator>> (URL& utcTime)
Reads a URL from the underlying input stream
AkentiInputStream& operator>> (DistinguishedName& dn)
Reads a DistinguishedName from the underlying input stream
AkentiInputStream& operator>> (AkentiObject& obj)
Read an AkentiObject from the underlying input stream

Documentation

An AkentiInputStream is used to deserialize objects from an ASCI string that was written using the conventions defined in AkentiOutputStream. This class provides input operations for standard C++ types such as chars, ints, longs and strings as well as Akenti-specific objects such as utctime, URL and Distinguished Names. Note that this object holds a reference to an underlying input stream and will only be valid as long as the underlying stream is valid. For the standard C++ types, this class just wraps the istream methods, so the standard conventions for reading from C++ streams are followed.
AkentiInputStream(istream& is)
Constructs this AkentiInputStream given a reference to an input stream specified by is.
Parameters:
is - istream the underlying input stream

~AkentiInputStream()
Destructor

AkentiInputStream& operator>>(char& c)
Reads a char from the underlying input stream.
Throws:
IOException if reading from the stream fails
Returns:
this AkentiInputStream for chaining
Parameters:
c - char an out parameter

AkentiInputStream& operator>>(int& n)
Reads a int from the underlying input stream.
Throws:
IOException if reading from the stream fails
Returns:
this AkentiInputStream for chaining
Parameters:
n - int out parameter
See Also:
IOException

AkentiInputStream& operator>>(bool& b)
Reads a bool from the underlying input stream.
Throws:
IOException if reading from the stream fails
Returns:
this AkentiInputStream for chaining
Parameters:
b - bool an out parameter
See Also:
IOException

AkentiInputStream& operator>>(long& l)
Reads a long from the underlying input stream.
Throws:
IOException if reading from the stream fails
Returns:
this AkentiInputStream for chaining
Parameters:
l - long an out parameter
See Also:
IOException

AkentiInputStream& operator>>(double& d)
Reads a double from the underlying input stream.
Throws:
IOException if reading from the stream fails
Returns:
this AkentiInputStream for chaining
Parameters:
d - double an out parameter
See Also:
IOException

char get()
Reads one char using the istream::get method from the underlying input stream.
Returns:
the char read

AkentiInputStream& read(char* buffer, int len)
Reads len chararacters from the underlying input stream into the buffer specified by buffer. Uses the istream::read method.
Parameters:
buffer - char* out parameter
len - number of chars to be read

AkentiInputStream& operator>>(string& s)
Reads a string from the underlying input stream. Implements the convention that the stream representation of a single string consists of ASCII characters terminated by a space unless the space is preceeded by a '\'. In that case the space is considered to be part of the string, and scanning continues until an non-escaped space is found.
Throws:
IOException if reading from the stream fails
Returns:
this AkentiInputStream for chaining
Parameters:
s - string out parameter
See Also:
IOException
AkentiOutputStream::write(string &s);

AkentiInputStream& operator>>(UtcTime& utcTime)
Reads a UtcTime from the underlying input stream.
Throws:
IOException if reading from the stream fails
Parameters:
utcTime - UtcTime out parameter
See Also:
UtcTime for the for external format
IOException

AkentiInputStream& operator>>(URL& utcTime)
Reads a URL from the underlying input stream.
Throws:
IOException if reading from the stream fails
Returns:
this AkentiInputStream for chaining
Parameters:
url - URL out parameter
See Also:
URL for the for external format
IOException

AkentiInputStream& operator>>(DistinguishedName& dn)
Reads a DistinguishedName from the underlying input stream.
Throws:
IOException if reading from the stream fails
Returns:
this AkentiInputStream for chaining
Parameters:
dn - DistinguishedName out parameter
See Also:
DistinguishedName for the for external format
IOException

AkentiInputStream& operator>>(AkentiObject& obj)
Read an AkentiObject from the underlying input stream. Calls the readObject method on the object handing it the AkentiInputStream.
Throws:
IOException if reading from the stream fails
Returns:
this AkentiInputStream for chaining
Parameters:
obj - AkentiObject out parameter
See Also:
AkentiObject


This class has no child classes.
Author:
Srilekha Mudumbai Abdelilah Essiari Xiang Sun
Version:
1.1 00/05/01
See Also:
AkentiOutputStream

alphabetic index hierarchy of classes


this page has been generated automatically by doc++

(c)opyright by Malte Zöckler, Roland Wunderling
contact: doc++@zib.de