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