Base class for InputStream implementations in SignDoc SDK. More...
#include <SignDocSDK-cpp.h>
Public Member Functions | |
| LibraryInputStream (SIGNDOC_InputStream *aImpl) | |
| Constructor. | |
| virtual int | read (void *aDst, int aLen) |
| Read octets from source. | |
| virtual void | close () |
| Close the stream. | |
| virtual void | seek (int aPos) |
| Seek to the specified position (int). | |
| virtual int | tell () const |
| Retrieve the current position (int). | |
| virtual int | getAvailable () |
| Get an estimate of the number of octets available for reading. | |
Detailed Description
Base class for InputStream implementations in SignDoc SDK.
Constructor & Destructor Documentation
| de::softpro::doc::LibraryInputStream::LibraryInputStream | ( | SIGNDOC_InputStream * | aImpl ) | [inline] |
Constructor.
- Parameters:
-
[in] aImpl A pointer to the C structure.
Member Function Documentation
| virtual void de::softpro::doc::LibraryInputStream::close | ( | ) | [inline, virtual] |
Close the stream.
Implementations of this class may define exceptions thrown by this function.
Implements de::softpro::doc::InputStream.
| virtual int de::softpro::doc::LibraryInputStream::getAvailable | ( | ) | [inline, virtual] |
Get an estimate of the number of octets available for reading.
Throws an exception if this function is not supported.
- Note:
- There may be more octets available than reported by this function, but never less. If there is at least one octet available for reading, the return value must be at least one. (That is, always returning zero is not possible.)
- Returns:
- The minimum number of octets available for reading.
Implements de::softpro::doc::InputStream.
| virtual int de::softpro::doc::LibraryInputStream::read | ( | void * | aDst, |
| int | aLen | ||
| ) | [inline, virtual] |
Read octets from source.
Implementations of this class may define exceptions thrown by this function.
Once this function has returned a value smaller than aLen, end of input has been reached and further calls should return 0.
- Parameters:
-
[out] aDst Pointer to buffer to be filled. [in] aLen Number of octets to read.
- Returns:
- The number of octets read.
Implements de::softpro::doc::InputStream.
| virtual void de::softpro::doc::LibraryInputStream::seek | ( | int | aPos ) | [inline, virtual] |
Seek to the specified position (int).
Throws an exception if the position is invalid or if seeking is not supported.
- Parameters:
-
[in] aPos The position (zero being the first octet).
Implements de::softpro::doc::InputStream.
| virtual int de::softpro::doc::LibraryInputStream::tell | ( | ) | const [inline, virtual] |
Retrieve the current position (int).
Throws an exception if the position cannot represented as non-negative int or if seeking is not supported.
- Returns:
- The current position (zero being the first octet)
Implements de::softpro::doc::InputStream.
The documentation for this class was generated from the following file:
