1 /* 2 * Copyright (C) 2022 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 #ifndef RINGBUFFER_H_ 18 #define RINGBUFFER_H_ 19 20 #include <list> 21 #include <vector> 22 23 namespace aidl { 24 namespace android { 25 namespace hardware { 26 namespace wifi { 27 28 /** 29 * Ringbuffer object used to store debug data. 30 */ 31 class Ringbuffer { 32 public: 33 // Error codes for the append ring buffer operation 34 enum AppendStatus { 35 SUCCESS, 36 FAIL_GENERIC, 37 FAIL_IP_BUFFER_ZERO, 38 FAIL_IP_BUFFER_EXCEEDED_MAXSIZE, 39 FAIL_RING_BUFFER_CORRUPTED 40 }; 41 explicit Ringbuffer(size_t maxSize); 42 43 // Appends the data buffer and deletes from the front until buffer is 44 // within |maxSize_|. 45 enum AppendStatus append(const std::vector<uint8_t>& input); 46 const std::list<std::vector<uint8_t>>& getData() const; 47 void clear(); 48 49 private: 50 std::list<std::vector<uint8_t>> data_; 51 size_t size_; 52 size_t maxSize_; 53 }; 54 55 } // namespace wifi 56 } // namespace hardware 57 } // namespace android 58 } // namespace aidl 59 60 #endif // RINGBUFFER_H_ 61