Juan Salazar / mbed

test

Dependents:   robotic_fish_7

Transaction.h@0:44931ff4a3ed, 2020-01-14 (annotated)

Committer:
juansal12
Date:
Tue Jan 14 19:14:29 2020 +0000
Revision:
0:44931ff4a3ed
Sofi 7 code;

Who changed what in which revision?

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