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

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.