SignDoc SDK (C++)
5.0.0
|
Interface for an input stream, inspired by Java's java.io.InputStream. More...
#include <SignDocSDK-cpp.h>
Public Member Functions | |
InputStream (SIGNDOC_InputStream *aImpl) | |
Constructor. More... | |
virtual | ~InputStream () |
Destructor. More... | |
virtual int | read (void *aDst, int aLen)=0 |
Read octets from source. More... | |
virtual void | close ()=0 |
Close the stream. More... | |
virtual void | seek (int aPos)=0 |
Seek to the specified position (int). More... | |
virtual int | tell () const =0 |
Retrieve the current position (int). More... | |
virtual int | getAvailable ()=0 |
Get an estimate of the number of octets available for reading. More... | |
SIGNDOC_InputStream * | getImpl () |
Internal. More... | |
Protected Attributes | |
SIGNDOC_InputStream * | p |
Pointer to C structure. More... | |
Interface for an input stream, inspired by Java's java.io.InputStream.
If you want to implement your own InputStream implementation, derive your class from UserInputStream.
|
inline |
Constructor.
[in] | aImpl | A pointer to the C structure. |
|
inlinevirtual |
Destructor.
|
pure virtual |
Close the stream.
Implementations of this class may define exceptions thrown by this function.
Implemented in LibraryInputStream.
|
pure virtual |
Get an estimate of the number of octets available for reading.
Throws an exception if this function is not supported.
Implemented in LibraryInputStream.
|
inline |
Internal.
|
pure 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.
[out] | aDst | Pointer to buffer to be filled. |
[in] | aLen | Number of octets to read. |
Implemented in LibraryInputStream.
|
pure virtual |
Seek to the specified position (int).
Throws an exception if the position is invalid or if seeking is not supported.
[in] | aPos | The position (zero being the first octet). |
Implemented in LibraryInputStream.
|
pure virtual |
Retrieve the current position (int).
Throws an exception if the position cannot represented as non-negative int or if seeking is not supported.
Implemented in LibraryInputStream.
|
protected |
Pointer to C structure.