class AkentiInputStream

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

Public Methods

[more] AkentiInputStream (istream& is)
Constructs this AkentiInputStream given a reference to an input stream specified by is.
[more] ~AkentiInputStream ()
Destructor
[more]AkentiInputStream& operator>> (char& c)
Reads a char from the underlying input stream.
[more]AkentiInputStream& operator>> (int& n)
Reads a int from the underlying input stream.
[more]AkentiInputStream& operator>> (bool& b)
Reads a bool from the underlying input stream.
[more]AkentiInputStream& operator>> (long& l)
Reads a long from the underlying input stream.
[more]AkentiInputStream& operator>> (double& d)
Reads a double from the underlying input stream.
[more]char get ()
Reads one char using the istream::get method from the underlying input stream.
[more]AkentiInputStream& read (char* buffer, int len)
Reads len chararacters from the underlying input stream into the buffer specified by buffer.
[more]AkentiInputStream& operator>> (string& s)
Reads a string from the underlying input stream.
[more]AkentiInputStream& operator>> (UtcTime& utcTime)
Reads a UtcTime from the underlying input stream.
[more]AkentiInputStream& operator>> (URL& utcTime)
Reads a URL from the underlying input stream.
[more]AkentiInputStream& operator>> (DistinguishedName& dn)
Reads a DistinguishedName from the underlying input stream.
[more]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.

o AkentiInputStream(istream& is)
Constructs this AkentiInputStream given a reference to an input stream specified by is.

Parameters:
is - istream the underlying input stream

o ~AkentiInputStream()
Destructor

oAkentiInputStream& operator>>(char& c)
Reads a char from the underlying input stream.

Throws:
IOException if reading from the stream fails
Parameters:
c - char an out parameter
Returns:
this AkentiInputStream for chaining

oAkentiInputStream& operator>>(int& n)
Reads a int from the underlying input stream.

Throws:
IOException if reading from the stream fails
Parameters:
n - int out parameter
Returns:
this AkentiInputStream for chaining
See Also:
IOException

oAkentiInputStream& operator>>(bool& b)
Reads a bool from the underlying input stream.

Throws:
IOException if reading from the stream fails
Parameters:
b - bool an out parameter
Returns:
this AkentiInputStream for chaining
See Also:
IOException

oAkentiInputStream& operator>>(long& l)
Reads a long from the underlying input stream.

Throws:
IOException if reading from the stream fails
Parameters:
l - long an out parameter
Returns:
this AkentiInputStream for chaining
See Also:
IOException

oAkentiInputStream& operator>>(double& d)
Reads a double from the underlying input stream.

Throws:
IOException if reading from the stream fails
Parameters:
d - double an out parameter
Returns:
this AkentiInputStream for chaining
See Also:
IOException

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

Returns:
the char read

oAkentiInputStream& 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

oAkentiInputStream& 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
Parameters:
s - string out parameter
Returns:
this AkentiInputStream for chaining
See Also:
IOException
AkentiOutputStream::write(string &s);

oAkentiInputStream& 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

oAkentiInputStream& operator>>(URL& utcTime)
Reads a URL from the underlying input stream.

Throws:
IOException if reading from the stream fails
Parameters:
url - URL out parameter
Returns:
this AkentiInputStream for chaining
See Also:
URL for the for external format
IOException

oAkentiInputStream& operator>>(DistinguishedName& dn)
Reads a DistinguishedName from the underlying input stream.

Throws:
IOException if reading from the stream fails
Parameters:
dn - DistinguishedName out parameter
Returns:
this AkentiInputStream for chaining
See Also:
DistinguishedName for the for external format
IOException

oAkentiInputStream& 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
Parameters:
obj - AkentiObject out parameter
Returns:
this AkentiInputStream for chaining
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 HTML hierarchy of classes or Java



This page was generated with the help of DOC++.