SignDoc SDK (C++)  5.0.0
Public Member Functions | Protected Attributes
InputStream Class Referenceabstract

Interface for an input stream, inspired by Java's java.io.InputStream. More...

#include <SignDocSDK-cpp.h>

Inheritance diagram for InputStream:
LibraryInputStream UserInputStream FileInputStream MemoryInputStream

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...
 

Detailed Description

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.

Constructor & Destructor Documentation

InputStream ( SIGNDOC_InputStream *  aImpl)
inline

Constructor.

Parameters
[in]aImplA pointer to the C structure.
virtual ~InputStream ( )
inlinevirtual

Destructor.

Member Function Documentation

virtual void close ( )
pure virtual

Close the stream.

Implementations of this class may define exceptions thrown by this function.

Implemented in LibraryInputStream.

virtual int getAvailable ( )
pure 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.

Implemented in LibraryInputStream.

SIGNDOC_InputStream* getImpl ( )
inline

Internal.

virtual int read ( void *  aDst,
int  aLen 
)
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.

Parameters
[out]aDstPointer to buffer to be filled.
[in]aLenNumber of octets to read.
Returns
The number of octets read.

Implemented in LibraryInputStream.

virtual void seek ( int  aPos)
pure virtual

Seek to the specified position (int).

Throws an exception if the position is invalid or if seeking is not supported.

Parameters
[in]aPosThe position (zero being the first octet).

Implemented in LibraryInputStream.

virtual int tell ( ) const
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.

Returns
The current position (zero being the first octet)

Implemented in LibraryInputStream.

Field Documentation

SIGNDOC_InputStream* p
protected

Pointer to C structure.

The documentation for this class was generated from the following file: