/usr/include/x86_64-linux-gnu/qcc/BufferedSink.h is in liballjoyn-common-dev-1504 15.04b-8.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 | /**
* @file
*
* This file defines a Sink wrapper/filter that buffers input I/O.
*/
/******************************************************************************
* Copyright AllSeen Alliance. All rights reserved.
*
* Permission to use, copy, modify, and/or distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
******************************************************************************/
#ifndef _QCC_BUFFEREDSINK_H
#define _QCC_BUFFEREDSINK_H
#include <qcc/platform.h>
#include <qcc/String.h>
#include <qcc/Event.h>
#include <qcc/Stream.h>
namespace qcc {
/**
* BufferedSink is an Sink wrapper that attempts to write fixed size blocks
* to an underyling (wrapped) Sink. It is typically used by Sinks which are
* slow or otherwise sensitive to small chunk writes.
*/
class BufferedSink : public Sink {
public:
/**
* Construct a BufferedSink
*
* @param sink Raw sink to be buffered.
* @param minChunk Preferred minimum write size for underlying sink.
*/
BufferedSink(Sink& sink, size_t minChunk);
/** Destructor */
virtual ~BufferedSink();
/**
* Push bytes to the sink.
*
* @param buf Bytes to write to sink.
* @param numBytes Number of bytes from buf to send to sink.
* @param numSent Number of bytes actually consumed by sink.
* @return ER_OK if successful.
*/
QStatus PushBytes(const void* buf, size_t numBytes, size_t& numSent);
/**
* Get the Event indicating that data is available when signaled.
*
* @return Event that is signaled when data is available.
*/
Event& GetSinkEvent() { return event; }
/**
* Enable write buffering for Sink types that support write buffering.
*
* @return ER_OK if write buffering is supported and was enabled.
*/
QStatus EnableWriteBuffer() { isBuffered = true; return ER_OK; }
/**
* Disable write buffering for Sink types that support write buffering.
*
* @return ER_OK if write buffering is supported and was disabled.
*/
QStatus DisableWriteBuffer() { Flush(); isBuffered = false; return ER_OK; }
/**
* Flush any buffered write.
*
* @return ER_OK if successful.
*/
QStatus Flush();
private:
/**
* Copy constructor is private and does nothing
*/
BufferedSink(const BufferedSink& other) : sink(other.sink), event(other.event), minChunk(other.minChunk), buf(NULL), wrPtr(NULL) { }
/**
* Assigment operator is private and does nothing
*/
BufferedSink& operator=(const BufferedSink&);
Sink& sink; /**< Underlying raw sink */
Event& event; /**< IO event for this buffered source */
const size_t minChunk; /**< Chunk size */
uint8_t* buf; /**< Heap allocated buffer */
uint8_t* wrPtr; /**< Pointer to next write position in buf */
size_t completeIdx; /**< Number of bytes already sent from buf */
bool isBuffered; /**< true iff write buffering is enabled */
};
}
#endif
|