/usr/include/x86_64-linux-gnu/qcc/ByteStreamPair.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 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 | /**
* @file
*
* Provides a pair of byte streams that can be used to buffer bi-directional
* stream traffic between two endpoints.
*/
/******************************************************************************
*
*
* 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_BYTESTREAMPAIR_H
#define _QCC_BYTESTREAMPAIR_H
#include <qcc/platform.h>
#include <qcc/String.h>
#include <qcc/Pipe.h>
#include <qcc/Stream.h>
namespace qcc {
/**
* Stream implementation returned by ByteStreamPair
*/
class ByteStream : public Stream {
public:
/** Construct an ByteStream */
ByteStream() : source(NULL) { };
/**
* Virtual destructor for derivable class.
*/
virtual ~ByteStream() { }
/**
* Get the source.
*
* @return Underlying source
*/
Source* GetSource() { return &pipe; }
/**
* Set the source.
*
* @param source Incomming byte source.
*/
void SetSource(Source* source) { this->source = source; }
/**
* Pull bytes from the ByteStream
* The source is exhausted when ER_EOF is returned.
*
* @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.
* @return ER_OK if successful. ER_EOF if source is exhausted. Otherwise an error.
*/
QStatus PullBytes(void* buf, size_t reqBytes, size_t& actualBytes)
{
QStatus status = ER_FAIL;
if (source) {
status = source->PullBytes(buf, reqBytes, actualBytes);
}
return status;
}
/**
* 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)
{
return pipe.PushBytes(buf, numBytes, numSent);
}
private:
Source* source;
Pipe pipe;
};
/**
* Provides a pair of byte streams that can be used to buffer bi-directional
* stream traffic between two endpoints.
*/
class ByteStreamPair {
public:
/**
* Construct an ByteStreamPair
*/
ByteStreamPair()
{
first.SetSource(second.GetSource());
second.SetSource(first.GetSource());
}
/**
* Virtual destructor for derivable class.
*/
virtual ~ByteStreamPair() { }
/**
* Get "first" Stream.
*
* @return Reference to "first" stream.
*/
Stream& GetFirstStream() { return first; }
/**
* Get "first" Stream.
*
* @return Reference to "second" stream.
*/
Stream& GetSecondStream() { return second; }
private:
ByteStream first; /**< "First" side byte stream */
ByteStream second; /**< "Second" side byte stream */
};
} /* namespace */
#endif
|