xref: /aosp_15_r20/hardware/interfaces/wifi/aidl/default/ringbuffer.h (revision 4d7e907c777eeecc4c5bd7cf640a754fac206ff7)

/*
 * Copyright (C) 2022 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef RINGBUFFER_H_
#define RINGBUFFER_H_

#include <list>
#include <vector>

namespace aidl {
namespace android {
namespace hardware {
namespace wifi {

/**
 * Ringbuffer object used to store debug data.
 */
class Ringbuffer {
  public:
    // Error codes for the append ring buffer operation
    enum AppendStatus {
        SUCCESS,
        FAIL_GENERIC,
        FAIL_IP_BUFFER_ZERO,
        FAIL_IP_BUFFER_EXCEEDED_MAXSIZE,
        FAIL_RING_BUFFER_CORRUPTED
    };
    explicit Ringbuffer(size_t maxSize);

    // Appends the data buffer and deletes from the front until buffer is
    // within |maxSize_|.
    enum AppendStatus append(const std::vector<uint8_t>& input);
    const std::list<std::vector<uint8_t>>& getData() const;
    void clear();

  private:
    std::list<std::vector<uint8_t>> data_;
    size_t size_;
    size_t maxSize_;
};

}  // namespace wifi
}  // namespace hardware
}  // namespace android
}  // namespace aidl

#endif  // RINGBUFFER_H_