/usr/include/x86_64-linux-gnu/qcc/Pipe.h is in liballjoyn-common-dev-1604 16.04a-3.
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 | /**
* @file
*
* Sink/Source implementation for storing/retrieving bytes
*/
/******************************************************************************
* 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_PIPE_H
#define _QCC_PIPE_H
#include <qcc/platform.h>
#include <qcc/String.h>
#include <qcc/Event.h>
#include <qcc/Mutex.h>
#include <qcc/Stream.h>
namespace qcc {
/**
* Pipe provides Sink/Source based storage for bytes.
* Pushing bytes into the Pipe's Sink will cause the bytes to become
* available at the Source.
*/
class Pipe : public Stream {
public:
/**
* Construct a Pipe.
*/
Pipe() : str(), outIdx(0), isWaiting(false) { }
/**
* Construct a Pipe from an existing string.
* @param str Input string.
*/
Pipe(const qcc::String str) : str(str), outIdx(0), isWaiting(false) { }
/** Destructor */
virtual ~Pipe() { }
/**
* Pull bytes from the ByteStream
* This call will block if there are no bytes available.
*
* @param buf Buffer to store pulled bytes
* @param reqBytes Number of bytes requested to be pulled from source.
* @param actualBytes Actual number of bytes retrieved from source.
* @param timeout Timeout in milliseconds.
* @return ER_OK if successful. ER_EOF if source is exhausted. Otherwise an error.
*/
QStatus PullBytes(void* buf, size_t reqBytes, size_t& actualBytes, uint32_t timeout = Event::WAIT_FOREVER);
/**
* Push bytes into the sink.
*
* @param buf Buffer to store pulled bytes
* @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);
/**
* Number of bytes avaiable to Pull
*
* @return The number of bytes tha can be pulled.
*/
size_t AvailBytes() { return str.size() - outIdx; }
private:
qcc::String str; /**< storage for byte stream */
size_t outIdx; /**< Index into str for next output char */
bool isWaiting; /**< true iff a thread is pending in PullBytes */
Mutex lock; /**< Mutex that protects pipe */
Event event; /**< Event used to signal availability of more bytes */
};
} /* namespace */
#endif
|