You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
63 lines
2.7 KiB
63 lines
2.7 KiB
/*
|
|
* Copyright (C) 2020 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.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <hidl/MQDescriptor.h>
|
|
#include "MessageQueueBase.h"
|
|
|
|
namespace android {
|
|
namespace hardware {
|
|
|
|
template <typename T, MQFlavor flavor>
|
|
struct MessageQueue final : public MessageQueueBase<MQDescriptor, T, flavor> {
|
|
typedef MQDescriptor<T, flavor> Descriptor;
|
|
MessageQueue(const Descriptor& Desc, bool resetPointers = true)
|
|
: MessageQueueBase<MQDescriptor, T, flavor>(Desc, resetPointers) {}
|
|
~MessageQueue() = default;
|
|
|
|
/**
|
|
* This constructor uses Ashmem shared memory to create an FMQ
|
|
* that can contain a maximum of 'numElementsInQueue' elements of type T.
|
|
*
|
|
* @param numElementsInQueue Capacity of the MessageQueue in terms of T.
|
|
* @param configureEventFlagWord Boolean that specifies if memory should
|
|
* also be allocated and mapped for an EventFlag word.
|
|
* @param bufferFd User-supplied file descriptor to map the memory for the ringbuffer
|
|
* By default, bufferFd=-1 means library will allocate ashmem region for ringbuffer.
|
|
* MessageQueue takes ownership of the file descriptor.
|
|
* @param bufferSize size of buffer in bytes that bufferFd represents. This
|
|
* size must be larger than or equal to (numElementsInQueue * sizeof(T)).
|
|
* Otherwise, operations will cause out-of-bounds memory access.
|
|
*/
|
|
MessageQueue(size_t numElementsInQueue, bool configureEventFlagWord,
|
|
android::base::unique_fd bufferFd, size_t bufferSize)
|
|
: MessageQueueBase<MQDescriptor, T, flavor>(numElementsInQueue, configureEventFlagWord,
|
|
std::move(bufferFd), bufferSize) {}
|
|
|
|
MessageQueue(size_t numElementsInQueue, bool configureEventFlagWord = false)
|
|
: MessageQueueBase<MQDescriptor, T, flavor>(numElementsInQueue, configureEventFlagWord,
|
|
android::base::unique_fd(), 0) {}
|
|
|
|
private:
|
|
MessageQueue(const MessageQueue& other) = delete;
|
|
MessageQueue& operator=(const MessageQueue& other) = delete;
|
|
MessageQueue() = delete;
|
|
};
|
|
|
|
} // namespace hardware
|
|
} // namespace android
|