Ignacio Carballeda / libxDot-mbed5-less

libxdot LESS version

MTS-Lora/vendor/multitech/MTS-Utils/MTSCircularBuffer.h@15:e098cf00f502, 2019-05-03 (annotated)

Committer:
icarballeda
Date:
Fri May 03 21:37:43 2019 +0000
Revision:
15:e098cf00f502
Parent:
2:4569491293d7 
CO2 is equal to -99 when it fails.; AppEUI, AppKEY & Radio Confs edited to work with Cisco Gateways (Multitech Compatible); Smartium: Added New message, alert string as in CDFS protocol.; Fixed: Accel & ux for errors

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1 #ifndef MTSCIRCULARBUFFER_H
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 2 #define MTSCIRCULARBUFFER_H
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 3
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 4 #include "Utils.h"
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 5
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 6 namespace mts
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 7 {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 8
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 9 /** This class provides a circular byte buffer meant for temporary storage
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 10 * during IO transactions. It contains many of the common methods you
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 11 * would expect from a circular buffer like read, write, and various
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 12 * methods for checking the size or status. It should be noted that
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 13 * this class does not include any special code for thread safety like
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 14 * a lock. In most cases this is not problematic, but is something
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 15 * to be aware of.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 16 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 17 class MTSCircularBuffer
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 18 {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 19 public:
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 20 /** Creates an MTSCircularBuffer object with the specified static size.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 21 *
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 22 * @prarm bufferSize size of the buffer in bytes.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 23 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 24 MTSCircularBuffer(int bufferSize);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 25
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 26 /** Destructs an MTSCircularBuffer object and frees all related resources.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 27 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 28 ~MTSCircularBuffer();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 29
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 30 /** This method enables bulk reads from the buffer. If more data is
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 31 * requested then available it simply returns all remaining data within the
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 32 * buffer.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 33 *
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 34 * @param data the buffer where data read will be added to.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 35 * @param length the amount of data in bytes to be read into the buffer.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 36 * @returns the total number of bytes that were read.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 37 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 38 int read(char* data, int length);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 39
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 40 /** This method reads a single byte from the buffer.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 41 *
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 42 * @param data char where the read byte will be stored.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 43 * @returns 1 if byte is read or 0 if no bytes available.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 44 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 45 int read(char& data);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 46
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 47 /** This method enables bulk writes to the buffer. If more data
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 48 * is requested to be written then space available the method writes
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 49 * as much data as possible and returns the actual amount written.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 50 *
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 51 * @param data the byte array to be written.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 52 * @param length the length of data to be written from the data paramter.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 53 * @returns the number of bytes written to the buffer, which is 0 if
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 54 * the buffer is full.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 55 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 56 int write(const char* data, int length);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 57
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 58 /** This method writes a signle byte as a char to the buffer.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 59 *
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 60 * @param data the byte to be written as a char.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 61 * @returns 1 if the byte was written or 0 if the buffer was full.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 62 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 63 int write(char data);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 64
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 65 /** This method is used to setup a callback funtion when the buffer reaches
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 66 * a certain threshold. The threshold condition is checked after every read
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 67 * and write call is completed. The condition is made up of both a threshold
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 68 * value and operator. An example that would trigger a callback is if the
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 69 * threshold was 10, the operator GREATER, and there were 12 bytes added to an
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 70 * empty buffer.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 71 *
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 72 * @param tptr a pointer to the object to be called when the condition is met.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 73 * @param mptr a pointer to the function within the object to be called when
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 74 * the condition is met.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 75 * @param threshold the value in bytes to be used as part of the condition.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 76 * @param op the operator to be used in conjunction with the threshold
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 77 * as part of the condition.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 78 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 79 template<typename T>
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 80 void attach(T *tptr, void( T::*mptr)(void), int threshold, RelationalOperator op) {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 81 _threshold = threshold;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 82 _op = op;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 83 notify.attach(tptr, mptr);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 84 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 85
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 86 /** This method is used to setup a callback funtion when the buffer reaches
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 87 * a certain threshold. The threshold condition is checked after every read
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 88 * and write call is completed. The condition is made up of both a threshold
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 89 * value and operator. An example that would trigger a callback is if the
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 90 * threshold was 10, the operator GREATER, and there were 12 bytes added to an
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 91 * empty buffer.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 92 *
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 93 * @param fptr a pointer to the static function to be called when the condition
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 94 * is met.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 95 * @param threshold the value in bytes to be used as part of the condition.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 96 * @param op the operator to be used in conjunction with the threshold
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 97 * as part of the condition.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 98 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 99 void attach(void(*fptr)(void), int threshold, RelationalOperator op) {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 100 _threshold = threshold;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 101 _op = op;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 102 notify.attach(fptr);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 103 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 104
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 105 /** This method returns the size of the storage space currently allocated for
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 106 * the buffer. This value is equivalent to the one passed into the constructor.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 107 * This value is equal or greater than the size() of the buffer.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 108 *
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 109 * @returns the allocated size of the buffer in bytes.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 110 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 111 int capacity();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 112
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 113 /** This method returns the amount of space left for writing.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 114 *
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 115 * @returns numbers of unused bytes in buffer.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 116 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 117 int remaining();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 118
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 119 /** This method returns the number of bytes available for reading.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 120 *
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 121 * @returns number of bytes currently in buffer.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 122 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 123 int size();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 124
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 125 /** This method returns whether the buffer is full.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 126 *
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 127 * @returns true if full, otherwise false.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 128 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 129 bool isFull();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 130
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 131 /** This method returns whether the buffer is empty.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 132 *
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 133 * @returns true if empty, otherwise false.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 134 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 135 bool isEmpty();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 136
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 137 /** This method clears the buffer. This is done through
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 138 * setting the internal read and write indexes to the same
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 139 * value and is therefore not an expensive operation.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 140 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 141 void clear();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 142
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 143
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 144 private:
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 145 int bufferSize; // total size of the buffer
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 146 char* buffer; // internal byte buffer as a character buffer
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 147 int readIndex; // read index for circular buffer
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 148 int writeIndex; // write index for circular buffer
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 149 int bytes; // available data
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 150 FunctionPointer notify; // function pointer used for the internal callback notification
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 151 int _threshold; // threshold for the notification
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 152 RelationalOperator _op; // operator that determines the direction of the threshold
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 153 void checkThreshold(); // private function that checks thresholds and processes notifications
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 154 };
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 155
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 156 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 157
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 158 #endif /* MTSCIRCULARBUFFER_H */