1*2afda31cSNiels Sascha Reedijk/* 2*2afda31cSNiels Sascha Reedijk * Copyright 2019 Haiku, Inc. All rights reserved. 3*2afda31cSNiels Sascha Reedijk * Distributed under the terms of the MIT License. 4*2afda31cSNiels Sascha Reedijk * 5*2afda31cSNiels Sascha Reedijk * Authors: 6*2afda31cSNiels Sascha Reedijk * Name, email@email.com 7*2afda31cSNiels Sascha Reedijk * 8*2afda31cSNiels Sascha Reedijk * Corresponds to: 9*2afda31cSNiels Sascha Reedijk * headers/os/support/BufferedDataIO.h hrev47422 10*2afda31cSNiels Sascha Reedijk * src/kits/support/BufferedDataIO.cpp hrev48615 11*2afda31cSNiels Sascha Reedijk */ 12*2afda31cSNiels Sascha Reedijk 13*2afda31cSNiels Sascha Reedijk 14*2afda31cSNiels Sascha Reedijk 15*2afda31cSNiels Sascha Reedijk 16*2afda31cSNiels Sascha Reedijk/*! 17*2afda31cSNiels Sascha Reedijk \file BufferedDataIO.h 18*2afda31cSNiels Sascha Reedijk \ingroup support 19*2afda31cSNiels Sascha Reedijk \ingroup libbe 20*2afda31cSNiels Sascha Reedijk \brief Undocumented file. 21*2afda31cSNiels Sascha Reedijk 22*2afda31cSNiels Sascha Reedijk \since Haiku R1 23*2afda31cSNiels Sascha Reedijk*/ 24*2afda31cSNiels Sascha Reedijk 25*2afda31cSNiels Sascha Reedijk 26*2afda31cSNiels Sascha Reedijk/*! 27*2afda31cSNiels Sascha Reedijk \class BBufferedDataIO 28*2afda31cSNiels Sascha Reedijk \ingroup support 29*2afda31cSNiels Sascha Reedijk \ingroup libbe 30*2afda31cSNiels Sascha Reedijk \brief Undocumented class. 31*2afda31cSNiels Sascha Reedijk 32*2afda31cSNiels Sascha Reedijk \since Haiku R1 33*2afda31cSNiels Sascha Reedijk*/ 34*2afda31cSNiels Sascha Reedijk 35*2afda31cSNiels Sascha Reedijk 36*2afda31cSNiels Sascha Reedijk/*! 37*2afda31cSNiels Sascha Reedijk \fn BBufferedDataIO::BBufferedDataIO(BDataIO &stream, size_t bufferSize=65536L, bool ownsStream=true, bool partialReads=false) 38*2afda31cSNiels Sascha Reedijk \brief Undocumented public method 39*2afda31cSNiels Sascha Reedijk 40*2afda31cSNiels Sascha Reedijk \param stream Undocumented 41*2afda31cSNiels Sascha Reedijk \param bufferSize Undocumented 42*2afda31cSNiels Sascha Reedijk \param ownsStream Undocumented 43*2afda31cSNiels Sascha Reedijk \param partialReads Undocumented 44*2afda31cSNiels Sascha Reedijk 45*2afda31cSNiels Sascha Reedijk \return Undocumented 46*2afda31cSNiels Sascha Reedijk \retval <value> Undocumented 47*2afda31cSNiels Sascha Reedijk 48*2afda31cSNiels Sascha Reedijk \since Haiku R1 49*2afda31cSNiels Sascha Reedijk*/ 50*2afda31cSNiels Sascha Reedijk 51*2afda31cSNiels Sascha Reedijk 52*2afda31cSNiels Sascha Reedijk/*! 53*2afda31cSNiels Sascha Reedijk \fn virtual virtual BBufferedDataIO::~BBufferedDataIO() 54*2afda31cSNiels Sascha Reedijk \brief Undocumented public method 55*2afda31cSNiels Sascha Reedijk 56*2afda31cSNiels Sascha Reedijk \return Undocumented 57*2afda31cSNiels Sascha Reedijk \retval <value> Undocumented 58*2afda31cSNiels Sascha Reedijk 59*2afda31cSNiels Sascha Reedijk \since Haiku R1 60*2afda31cSNiels Sascha Reedijk*/ 61*2afda31cSNiels Sascha Reedijk 62*2afda31cSNiels Sascha Reedijk 63*2afda31cSNiels Sascha Reedijk/*! 64*2afda31cSNiels Sascha Reedijk \fn status_t BBufferedDataIO::InitCheck() const 65*2afda31cSNiels Sascha Reedijk \brief Undocumented public method 66*2afda31cSNiels Sascha Reedijk 67*2afda31cSNiels Sascha Reedijk \return Undocumented 68*2afda31cSNiels Sascha Reedijk \retval <value> Undocumented 69*2afda31cSNiels Sascha Reedijk 70*2afda31cSNiels Sascha Reedijk \since Haiku R1 71*2afda31cSNiels Sascha Reedijk*/ 72*2afda31cSNiels Sascha Reedijk 73*2afda31cSNiels Sascha Reedijk 74*2afda31cSNiels Sascha Reedijk/*! 75*2afda31cSNiels Sascha Reedijk \fn BDataIO* BBufferedDataIO::Stream() const 76*2afda31cSNiels Sascha Reedijk \brief Undocumented public method 77*2afda31cSNiels Sascha Reedijk 78*2afda31cSNiels Sascha Reedijk \return Undocumented 79*2afda31cSNiels Sascha Reedijk \retval <value> Undocumented 80*2afda31cSNiels Sascha Reedijk 81*2afda31cSNiels Sascha Reedijk \since Haiku R1 82*2afda31cSNiels Sascha Reedijk*/ 83*2afda31cSNiels Sascha Reedijk 84*2afda31cSNiels Sascha Reedijk 85*2afda31cSNiels Sascha Reedijk/*! 86*2afda31cSNiels Sascha Reedijk \fn size_t BBufferedDataIO::BufferSize() const 87*2afda31cSNiels Sascha Reedijk \brief Undocumented public method 88*2afda31cSNiels Sascha Reedijk 89*2afda31cSNiels Sascha Reedijk \return Undocumented 90*2afda31cSNiels Sascha Reedijk \retval <value> Undocumented 91*2afda31cSNiels Sascha Reedijk 92*2afda31cSNiels Sascha Reedijk \since Haiku R1 93*2afda31cSNiels Sascha Reedijk*/ 94*2afda31cSNiels Sascha Reedijk 95*2afda31cSNiels Sascha Reedijk 96*2afda31cSNiels Sascha Reedijk/*! 97*2afda31cSNiels Sascha Reedijk \fn bool BBufferedDataIO::OwnsStream() const 98*2afda31cSNiels Sascha Reedijk \brief Undocumented public method 99*2afda31cSNiels Sascha Reedijk 100*2afda31cSNiels Sascha Reedijk \return Undocumented 101*2afda31cSNiels Sascha Reedijk \retval <value> Undocumented 102*2afda31cSNiels Sascha Reedijk 103*2afda31cSNiels Sascha Reedijk \since Haiku R1 104*2afda31cSNiels Sascha Reedijk*/ 105*2afda31cSNiels Sascha Reedijk 106*2afda31cSNiels Sascha Reedijk 107*2afda31cSNiels Sascha Reedijk/*! 108*2afda31cSNiels Sascha Reedijk \fn void BBufferedDataIO::SetOwnsStream(bool ownsStream) 109*2afda31cSNiels Sascha Reedijk \brief Undocumented public method 110*2afda31cSNiels Sascha Reedijk 111*2afda31cSNiels Sascha Reedijk \param ownsStream Undocumented 112*2afda31cSNiels Sascha Reedijk 113*2afda31cSNiels Sascha Reedijk \since Haiku R1 114*2afda31cSNiels Sascha Reedijk*/ 115*2afda31cSNiels Sascha Reedijk 116*2afda31cSNiels Sascha Reedijk 117*2afda31cSNiels Sascha Reedijk/*! 118*2afda31cSNiels Sascha Reedijk \fn virtual status_t BBufferedDataIO::Flush() 119*2afda31cSNiels Sascha Reedijk \brief Undocumented public method 120*2afda31cSNiels Sascha Reedijk 121*2afda31cSNiels Sascha Reedijk \return Undocumented 122*2afda31cSNiels Sascha Reedijk \retval <value> Undocumented 123*2afda31cSNiels Sascha Reedijk 124*2afda31cSNiels Sascha Reedijk \since Haiku R1 125*2afda31cSNiels Sascha Reedijk*/ 126*2afda31cSNiels Sascha Reedijk 127*2afda31cSNiels Sascha Reedijk 128*2afda31cSNiels Sascha Reedijk/*! 129*2afda31cSNiels Sascha Reedijk \fn virtual virtual ssize_t BBufferedDataIO::Read(void *buffer, size_t size) 130*2afda31cSNiels Sascha Reedijk \brief Undocumented public method 131*2afda31cSNiels Sascha Reedijk 132*2afda31cSNiels Sascha Reedijk \param buffer Undocumented 133*2afda31cSNiels Sascha Reedijk \param size Undocumented 134*2afda31cSNiels Sascha Reedijk 135*2afda31cSNiels Sascha Reedijk \return Undocumented 136*2afda31cSNiels Sascha Reedijk \retval <value> Undocumented 137*2afda31cSNiels Sascha Reedijk 138*2afda31cSNiels Sascha Reedijk \since Haiku R1 139*2afda31cSNiels Sascha Reedijk*/ 140*2afda31cSNiels Sascha Reedijk 141*2afda31cSNiels Sascha Reedijk 142*2afda31cSNiels Sascha Reedijk/*! 143*2afda31cSNiels Sascha Reedijk \fn virtual virtual ssize_t BBufferedDataIO::Write(const void *buffer, size_t size) 144*2afda31cSNiels Sascha Reedijk \brief Undocumented public method 145*2afda31cSNiels Sascha Reedijk 146*2afda31cSNiels Sascha Reedijk \param buffer Undocumented 147*2afda31cSNiels Sascha Reedijk \param size Undocumented 148*2afda31cSNiels Sascha Reedijk 149*2afda31cSNiels Sascha Reedijk \return Undocumented 150*2afda31cSNiels Sascha Reedijk \retval <value> Undocumented 151*2afda31cSNiels Sascha Reedijk 152*2afda31cSNiels Sascha Reedijk \since Haiku R1 153*2afda31cSNiels Sascha Reedijk*/ 154