Kenji Arai / mbed-os_TYBLE16

mbed-os5 only for TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

drivers/internal/OperationList.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_H
kenjiArai 1:9db0e321a9f4 19 #define MBED_OPERATION_LIST_H
kenjiArai 1:9db0e321a9f4 20
kenjiArai 1:9db0e321a9f4 21 #include "OperationListBase.h"
kenjiArai 1:9db0e321a9f4 22 #include "AsyncOp.h"
kenjiArai 1:9db0e321a9f4 23
kenjiArai 1:9db0e321a9f4 24 /**
kenjiArai 1:9db0e321a9f4 25 * \defgroup drivers_OperationList OperationList class
kenjiArai 1:9db0e321a9f4 26 * \ingroup drivers-internal-api-usb
kenjiArai 1:9db0e321a9f4 27 * @{
kenjiArai 1:9db0e321a9f4 28 */
kenjiArai 1:9db0e321a9f4 29 template<class T>
kenjiArai 1:9db0e321a9f4 30 class OperationList: public 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 OperationList()
kenjiArai 1:9db0e321a9f4 37 {
kenjiArai 1:9db0e321a9f4 38
kenjiArai 1:9db0e321a9f4 39 }
kenjiArai 1:9db0e321a9f4 40
kenjiArai 1:9db0e321a9f4 41 /**
kenjiArai 1:9db0e321a9f4 42 * Destroy this object and abort all operations
kenjiArai 1:9db0e321a9f4 43 */
kenjiArai 1:9db0e321a9f4 44 ~OperationList()
kenjiArai 1:9db0e321a9f4 45 {
kenjiArai 1:9db0e321a9f4 46
kenjiArai 1:9db0e321a9f4 47 }
kenjiArai 1:9db0e321a9f4 48 /**
kenjiArai 1:9db0e321a9f4 49 * Add an operation to the list
kenjiArai 1:9db0e321a9f4 50 *
kenjiArai 1:9db0e321a9f4 51 * If the list was empty then call process on this
kenjiArai 1:9db0e321a9f4 52 * operation
kenjiArai 1:9db0e321a9f4 53 *
kenjiArai 1:9db0e321a9f4 54 * @param op Operation to add
kenjiArai 1:9db0e321a9f4 55 */
kenjiArai 1:9db0e321a9f4 56 void add(T *op)
kenjiArai 1:9db0e321a9f4 57 {
kenjiArai 1:9db0e321a9f4 58 OperationListBase::add(op);
kenjiArai 1:9db0e321a9f4 59 }
kenjiArai 1:9db0e321a9f4 60
kenjiArai 1:9db0e321a9f4 61 /**
kenjiArai 1:9db0e321a9f4 62 * Remove an operation from the list
kenjiArai 1:9db0e321a9f4 63 *
kenjiArai 1:9db0e321a9f4 64 * If this was the head of the list then process the
kenjiArai 1:9db0e321a9f4 65 * next element in the list.
kenjiArai 1:9db0e321a9f4 66 *
kenjiArai 1:9db0e321a9f4 67 * @param op Operation to remove
kenjiArai 1:9db0e321a9f4 68 */
kenjiArai 1:9db0e321a9f4 69 void remove(T *op)
kenjiArai 1:9db0e321a9f4 70 {
kenjiArai 1:9db0e321a9f4 71 OperationListBase::remove(op);
kenjiArai 1:9db0e321a9f4 72 }
kenjiArai 1:9db0e321a9f4 73
kenjiArai 1:9db0e321a9f4 74 /**
kenjiArai 1:9db0e321a9f4 75 * Dequeue the head of the list
kenjiArai 1:9db0e321a9f4 76 *
kenjiArai 1:9db0e321a9f4 77 * Remove the head of the operation list without completing it
kenjiArai 1:9db0e321a9f4 78 * or processing the next element. The caller must call the
kenjiArai 1:9db0e321a9f4 79 * AsnycOp::complete() function of the returned object.
kenjiArai 1:9db0e321a9f4 80 * Additionally process() must be called on this object
kenjiArai 1:9db0e321a9f4 81 * if there are still elements in the list.
kenjiArai 1:9db0e321a9f4 82 *
kenjiArai 1:9db0e321a9f4 83 * @return The asynchronous op at the head of the list
kenjiArai 1:9db0e321a9f4 84 */
kenjiArai 1:9db0e321a9f4 85 T *dequeue_raw()
kenjiArai 1:9db0e321a9f4 86 {
kenjiArai 1:9db0e321a9f4 87 return static_cast<AsyncOp *>(OperationListBase::dequeue_raw());
kenjiArai 1:9db0e321a9f4 88 }
kenjiArai 1:9db0e321a9f4 89
kenjiArai 1:9db0e321a9f4 90 };
kenjiArai 1:9db0e321a9f4 91
kenjiArai 1:9db0e321a9f4 92 /** @}*/
kenjiArai 1:9db0e321a9f4 93
kenjiArai 1:9db0e321a9f4 94 #endif