Kenji Arai / mbed-os_TYBLE16

mbed-os5 only for TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

drivers/internal/OperationListBase.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_OPERATION_LIST_BASE_H
kenjiArai 1:9db0e321a9f4 19 #define MBED_OPERATION_LIST_BASE_H
kenjiArai 1:9db0e321a9f4 20
kenjiArai 1:9db0e321a9f4 21 #include "drivers/internal/LinkedListBase.h"
kenjiArai 1:9db0e321a9f4 22
kenjiArai 1:9db0e321a9f4 23 class AsyncOp;
kenjiArai 1:9db0e321a9f4 24
kenjiArai 1:9db0e321a9f4 25 /**
kenjiArai 1:9db0e321a9f4 26 * \defgroup drivers_OperationListBase OperationListBase class
kenjiArai 1:9db0e321a9f4 27 * \ingroup drivers-internal-api-usb
kenjiArai 1:9db0e321a9f4 28 * @{
kenjiArai 1:9db0e321a9f4 29 */
kenjiArai 1:9db0e321a9f4 30 class OperationListBase {
kenjiArai 1:9db0e321a9f4 31 public:
kenjiArai 1:9db0e321a9f4 32
kenjiArai 1:9db0e321a9f4 33 /**
kenjiArai 1:9db0e321a9f4 34 * Create a new empty operation list
kenjiArai 1:9db0e321a9f4 35 */
kenjiArai 1:9db0e321a9f4 36 OperationListBase();
kenjiArai 1:9db0e321a9f4 37
kenjiArai 1:9db0e321a9f4 38 /**
kenjiArai 1:9db0e321a9f4 39 * Destroy this object and abort all operations
kenjiArai 1:9db0e321a9f4 40 */
kenjiArai 1:9db0e321a9f4 41 ~OperationListBase();
kenjiArai 1:9db0e321a9f4 42
kenjiArai 1:9db0e321a9f4 43 /**
kenjiArai 1:9db0e321a9f4 44 * Check if the list is empty
kenjiArai 1:9db0e321a9f4 45 *
kenjiArai 1:9db0e321a9f4 46 * @return true if the list is empty false otherwise
kenjiArai 1:9db0e321a9f4 47 */
kenjiArai 1:9db0e321a9f4 48 bool empty();
kenjiArai 1:9db0e321a9f4 49
kenjiArai 1:9db0e321a9f4 50 /**
kenjiArai 1:9db0e321a9f4 51 * Add an operation to the list
kenjiArai 1:9db0e321a9f4 52 *
kenjiArai 1:9db0e321a9f4 53 * If the list was empty then call process on this
kenjiArai 1:9db0e321a9f4 54 * operation
kenjiArai 1:9db0e321a9f4 55 *
kenjiArai 1:9db0e321a9f4 56 * @param op Operation to add
kenjiArai 1:9db0e321a9f4 57 */
kenjiArai 1:9db0e321a9f4 58 void add(AsyncOp *op);
kenjiArai 1:9db0e321a9f4 59
kenjiArai 1:9db0e321a9f4 60 /**
kenjiArai 1:9db0e321a9f4 61 * Remove an operation from the list
kenjiArai 1:9db0e321a9f4 62 *
kenjiArai 1:9db0e321a9f4 63 * If this was the head of the list then process the
kenjiArai 1:9db0e321a9f4 64 * next element in the list.
kenjiArai 1:9db0e321a9f4 65 *
kenjiArai 1:9db0e321a9f4 66 * @param op Operation to remove
kenjiArai 1:9db0e321a9f4 67 */
kenjiArai 1:9db0e321a9f4 68 void remove(AsyncOp *op);
kenjiArai 1:9db0e321a9f4 69
kenjiArai 1:9db0e321a9f4 70 /**
kenjiArai 1:9db0e321a9f4 71 * Dequeue the head of the list
kenjiArai 1:9db0e321a9f4 72 *
kenjiArai 1:9db0e321a9f4 73 * Remove the head of the operation list without completing it
kenjiArai 1:9db0e321a9f4 74 * or processing the next element. The caller must call the
kenjiArai 1:9db0e321a9f4 75 * AsnycOp::complete() function of the returned object.
kenjiArai 1:9db0e321a9f4 76 * Additionally process() must be called on this object
kenjiArai 1:9db0e321a9f4 77 * if there are still elements in the list.
kenjiArai 1:9db0e321a9f4 78 *
kenjiArai 1:9db0e321a9f4 79 * @return The asynchronous op at the head of the list
kenjiArai 1:9db0e321a9f4 80 */
kenjiArai 1:9db0e321a9f4 81 AsyncOp *dequeue_raw();
kenjiArai 1:9db0e321a9f4 82
kenjiArai 1:9db0e321a9f4 83 /**
kenjiArai 1:9db0e321a9f4 84 * Abort all operations
kenjiArai 1:9db0e321a9f4 85 */
kenjiArai 1:9db0e321a9f4 86 void remove_all();
kenjiArai 1:9db0e321a9f4 87
kenjiArai 1:9db0e321a9f4 88 /**
kenjiArai 1:9db0e321a9f4 89 * Process the operation list
kenjiArai 1:9db0e321a9f4 90 *
kenjiArai 1:9db0e321a9f4 91 * This allow the operation at the head of the list to perform processing
kenjiArai 1:9db0e321a9f4 92 */
kenjiArai 1:9db0e321a9f4 93 void process();
kenjiArai 1:9db0e321a9f4 94
kenjiArai 1:9db0e321a9f4 95 private:
kenjiArai 1:9db0e321a9f4 96 friend class AsyncOp;
kenjiArai 1:9db0e321a9f4 97
kenjiArai 1:9db0e321a9f4 98 LinkedListBase _list;
kenjiArai 1:9db0e321a9f4 99 };
kenjiArai 1:9db0e321a9f4 100
kenjiArai 1:9db0e321a9f4 101 /** @}*/
kenjiArai 1:9db0e321a9f4 102
kenjiArai 1:9db0e321a9f4 103 #endif