Juan Salazar / sofi7

test

Dependents:   robotic_fish_6

Transaction.h@0:c792b17d9f78, 2021-12-03 (annotated)

Committer:
juansal12
Date:
Fri Dec 03 23:00:34 2021 +0000
Revision:
0:c792b17d9f78
uploaded sofi code ;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
juansal12 0:c792b17d9f78 1 /* mbed Microcontroller Library
juansal12 0:c792b17d9f78 2 * Copyright (c) 2015 ARM Limited
juansal12 0:c792b17d9f78 3 *
juansal12 0:c792b17d9f78 4 * Licensed under the Apache License, Version 2.0 (the "License");
juansal12 0:c792b17d9f78 5 * you may not use this file except in compliance with the License.
juansal12 0:c792b17d9f78 6 * You may obtain a copy of the License at
juansal12 0:c792b17d9f78 7 *
juansal12 0:c792b17d9f78 8 * http://www.apache.org/licenses/LICENSE-2.0
juansal12 0:c792b17d9f78 9 *
juansal12 0:c792b17d9f78 10 * Unless required by applicable law or agreed to in writing, software
juansal12 0:c792b17d9f78 11 * distributed under the License is distributed on an "AS IS" BASIS,
juansal12 0:c792b17d9f78 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
juansal12 0:c792b17d9f78 13 * See the License for the specific language governing permissions and
juansal12 0:c792b17d9f78 14 * limitations under the License.
juansal12 0:c792b17d9f78 15 */
juansal12 0:c792b17d9f78 16 #ifndef MBED_TRANSACTION_H
juansal12 0:c792b17d9f78 17 #define MBED_TRANSACTION_H
juansal12 0:c792b17d9f78 18
juansal12 0:c792b17d9f78 19 #include "platform.h"
juansal12 0:c792b17d9f78 20 #include "FunctionPointer.h"
juansal12 0:c792b17d9f78 21
juansal12 0:c792b17d9f78 22 namespace mbed {
juansal12 0:c792b17d9f78 23
juansal12 0:c792b17d9f78 24 /** Transaction structure
juansal12 0:c792b17d9f78 25 */
juansal12 0:c792b17d9f78 26 typedef struct {
juansal12 0:c792b17d9f78 27 void *tx_buffer; /**< Tx buffer */
juansal12 0:c792b17d9f78 28 size_t tx_length; /**< Length of Tx buffer*/
juansal12 0:c792b17d9f78 29 void *rx_buffer; /**< Rx buffer */
juansal12 0:c792b17d9f78 30 size_t rx_length; /**< Length of Rx buffer */
juansal12 0:c792b17d9f78 31 uint32_t event; /**< Event for a transaction */
juansal12 0:c792b17d9f78 32 event_callback_t callback; /**< User's callback */
juansal12 0:c792b17d9f78 33 uint8_t width; /**< Buffer's word width (8, 16, 32, 64) */
juansal12 0:c792b17d9f78 34 } transaction_t;
juansal12 0:c792b17d9f78 35
juansal12 0:c792b17d9f78 36 /** Transaction class defines a transaction.
juansal12 0:c792b17d9f78 37 */
juansal12 0:c792b17d9f78 38 template<typename Class>
juansal12 0:c792b17d9f78 39 class Transaction {
juansal12 0:c792b17d9f78 40 public:
juansal12 0:c792b17d9f78 41 Transaction(Class *tpointer, const transaction_t& transaction) : _obj(tpointer), _data(transaction) {
juansal12 0:c792b17d9f78 42 }
juansal12 0:c792b17d9f78 43
juansal12 0:c792b17d9f78 44 Transaction() : _obj(), _data() {
juansal12 0:c792b17d9f78 45 }
juansal12 0:c792b17d9f78 46
juansal12 0:c792b17d9f78 47 ~Transaction() {
juansal12 0:c792b17d9f78 48 }
juansal12 0:c792b17d9f78 49
juansal12 0:c792b17d9f78 50 /** Get object's instance for the transaction
juansal12 0:c792b17d9f78 51 *
juansal12 0:c792b17d9f78 52 * @return The object which was stored
juansal12 0:c792b17d9f78 53 */
juansal12 0:c792b17d9f78 54 Class* get_object() {
juansal12 0:c792b17d9f78 55 return _obj;
juansal12 0:c792b17d9f78 56 }
juansal12 0:c792b17d9f78 57
juansal12 0:c792b17d9f78 58 /** Get the transaction
juansal12 0:c792b17d9f78 59 *
juansal12 0:c792b17d9f78 60 * @return The transaction which was stored
juansal12 0:c792b17d9f78 61 */
juansal12 0:c792b17d9f78 62 transaction_t* get_transaction() {
juansal12 0:c792b17d9f78 63 return &_data;
juansal12 0:c792b17d9f78 64 }
juansal12 0:c792b17d9f78 65
juansal12 0:c792b17d9f78 66 private:
juansal12 0:c792b17d9f78 67 Class* _obj;
juansal12 0:c792b17d9f78 68 transaction_t _data;
juansal12 0:c792b17d9f78 69 };
juansal12 0:c792b17d9f78 70
juansal12 0:c792b17d9f78 71 }
juansal12 0:c792b17d9f78 72
juansal12 0:c792b17d9f78 73 #endif