Kenji Arai / mbed-os_TYBLE16

mbed-os5 only for TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

drivers/internal/LinkedListBase.h@1:9db0e321a9f4, 2019-12-31 (annotated)

Committer:
kenjiArai
Date:
Tue Dec 31 06:02:27 2019 +0000
Revision:
1:9db0e321a9f4
updated based on mbed-os5.15.0

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kenjiArai 1:9db0e321a9f4 1 /*
kenjiArai 1:9db0e321a9f4 2 * Copyright (c) 2018-2019, Arm Limited and affiliates.
kenjiArai 1:9db0e321a9f4 3 * SPDX-License-Identifier: Apache-2.0
kenjiArai 1:9db0e321a9f4 4 *
kenjiArai 1:9db0e321a9f4 5 * Licensed under the Apache License, Version 2.0 (the "License");
kenjiArai 1:9db0e321a9f4 6 * you may not use this file except in compliance with the License.
kenjiArai 1:9db0e321a9f4 7 * You may obtain a copy of the License at
kenjiArai 1:9db0e321a9f4 8 *
kenjiArai 1:9db0e321a9f4 9 * http://www.apache.org/licenses/LICENSE-2.0
kenjiArai 1:9db0e321a9f4 10 *
kenjiArai 1:9db0e321a9f4 11 * Unless required by applicable law or agreed to in writing, software
kenjiArai 1:9db0e321a9f4 12 * distributed under the License is distributed on an "AS IS" BASIS,
kenjiArai 1:9db0e321a9f4 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
kenjiArai 1:9db0e321a9f4 14 * See the License for the specific language governing permissions and
kenjiArai 1:9db0e321a9f4 15 * limitations under the License.
kenjiArai 1:9db0e321a9f4 16 */
kenjiArai 1:9db0e321a9f4 17
kenjiArai 1:9db0e321a9f4 18 #ifndef MBED_LINKED_LIST_BASE_H
kenjiArai 1:9db0e321a9f4 19 #define MBED_LINKED_LIST_BASE_H
kenjiArai 1:9db0e321a9f4 20
kenjiArai 1:9db0e321a9f4 21 #include "LinkEntry.h"
kenjiArai 1:9db0e321a9f4 22
kenjiArai 1:9db0e321a9f4 23 /**
kenjiArai 1:9db0e321a9f4 24 * \defgroup drivers_LinkedListBase LinkedListBase class
kenjiArai 1:9db0e321a9f4 25 * \ingroup drivers-internal-api-usb
kenjiArai 1:9db0e321a9f4 26 * @{
kenjiArai 1:9db0e321a9f4 27 */
kenjiArai 1:9db0e321a9f4 28 class LinkedListBase {
kenjiArai 1:9db0e321a9f4 29 public:
kenjiArai 1:9db0e321a9f4 30 LinkedListBase();
kenjiArai 1:9db0e321a9f4 31 ~LinkedListBase();
kenjiArai 1:9db0e321a9f4 32
kenjiArai 1:9db0e321a9f4 33 /**
kenjiArai 1:9db0e321a9f4 34 * Return the element at the head of the list
kenjiArai 1:9db0e321a9f4 35 *
kenjiArai 1:9db0e321a9f4 36 * @return The element at the head of the list or NULL if the list is empty
kenjiArai 1:9db0e321a9f4 37 */
kenjiArai 1:9db0e321a9f4 38 LinkEntry *head();
kenjiArai 1:9db0e321a9f4 39
kenjiArai 1:9db0e321a9f4 40 /**
kenjiArai 1:9db0e321a9f4 41 * Add an element to the tail of the list
kenjiArai 1:9db0e321a9f4 42 *
kenjiArai 1:9db0e321a9f4 43 * @param entry New element to add
kenjiArai 1:9db0e321a9f4 44 */
kenjiArai 1:9db0e321a9f4 45 void enqueue(LinkEntry *entry);
kenjiArai 1:9db0e321a9f4 46
kenjiArai 1:9db0e321a9f4 47 /**
kenjiArai 1:9db0e321a9f4 48 * Remove the element at the head of the list
kenjiArai 1:9db0e321a9f4 49 *
kenjiArai 1:9db0e321a9f4 50 * @return The element at the head of the list or NULL if the list is empty
kenjiArai 1:9db0e321a9f4 51 */
kenjiArai 1:9db0e321a9f4 52 LinkEntry *dequeue();
kenjiArai 1:9db0e321a9f4 53
kenjiArai 1:9db0e321a9f4 54 /**
kenjiArai 1:9db0e321a9f4 55 * Remove the specified element if it is in the list
kenjiArai 1:9db0e321a9f4 56 *
kenjiArai 1:9db0e321a9f4 57 * @param entry Element to remove from the list
kenjiArai 1:9db0e321a9f4 58 */
kenjiArai 1:9db0e321a9f4 59 void remove(LinkEntry *entry);
kenjiArai 1:9db0e321a9f4 60
kenjiArai 1:9db0e321a9f4 61 private:
kenjiArai 1:9db0e321a9f4 62 LinkEntry *_head;
kenjiArai 1:9db0e321a9f4 63 LinkEntry *_tail;
kenjiArai 1:9db0e321a9f4 64 };
kenjiArai 1:9db0e321a9f4 65
kenjiArai 1:9db0e321a9f4 66 /** @}*/
kenjiArai 1:9db0e321a9f4 67
kenjiArai 1:9db0e321a9f4 68 #endif