libimage  0.25.4
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Énumérations Macros Pages
Fonctions membres publiques | Liste de tous les membres
Référence de la classe DataStream

#include <Data.h>

Graphe d'héritage de DataStream:
Inheritance graph
Graphe de collaboration de DataStream:
Collaboration graph

Fonctions membres publiques

virtual ~DataStream ()
virtual size_t read (uint8_t *buffer, size_t size)=0
virtual bool eof ()=0
virtual std::string getType ()=0
virtual int getHttpStatus ()=0
virtual std::string getEncoding ()=0

Description détaillée

Interface abstraite permetant d'encapsuler un flux de données.

Documentation des constructeurs et destructeur

virtual DataStream::~DataStream ( )
inlinevirtual

Destructeur virtuel

Documentation des fonctions membres

virtual bool DataStream::eof ( )
pure virtual

Indique la fin du flux. read() renverra systématiquement 0 lorsque la fin du flux est atteinte.

Renvoie
true s'il n'y a plus de données à lire.

Implémenté dans JPEGEncoder, PNGEncoder, TiffEncoder, et BilEncoder.

Voici le graphe des appelants de cette fonction :

virtual std::string DataStream::getEncoding ( )
pure virtual

Indique l'encodage associé au flux.

Implémenté dans TiffDeflateEncoder< T >, JPEGEncoder, TiffEncoder, PNGEncoder, et BilEncoder.

virtual int DataStream::getHttpStatus ( )
pure virtual

Indique le statut Http associé au flux.

Implémenté dans JPEGEncoder, PNGEncoder, TiffEncoder, et BilEncoder.

virtual std::string DataStream::getType ( )
pure virtual

Indique le type MIME associé au flux.

Implémenté dans JPEGEncoder, PNGEncoder, TiffEncoder, et BilEncoder.

virtual size_t DataStream::read ( uint8_t *  buffer,
size_t  size 
)
pure virtual

Lit les prochaines données du flux. Tout octet ne peut être lu qu'une seule fois.

Copie au plus size octets de données non lues dans buffer. La valeur de retour indique le nombre d'octets effectivement lus.

Une valeur de retour 0 n'indique pas forcément la fin du flux, en effet il peut ne pas y avoir assez de place dans buffer pour écrire les données. Ce genre de limitation est spécifique à chaque classe filles qui peut pour des commodités d'implémentation ne pas vouloir tronquer certains blocs de données.

Paramètres
bufferPointeur cible.
sizeEspace disponible dans buffer en octets.
Renvoie
Nombre d'octets effectivement récupérés.

Implémenté dans JPEGEncoder, PNGEncoder, TiffEncoder, et BilEncoder.

Voici le graphe des appelants de cette fonction :


La documentation de cette classe a été générée à partir du fichier suivant :