Lancaster University / mbed-dev-bin

Binary version of Lancaster University's mbed branch, soon to be merged. The source lives here:https://developer.mbed.org/teams/Lancaster-University/code/mbed-src/

Dependents:   microbit-dal microbit-ble-open microbit-dal-eddystone microbit-dal ... more

Fork of mbed-lite-test by Lancaster University

Transaction.h@3:768173a57492, 2016-07-13 (annotated)

Committer:
jamesadevine
Date:
Wed Jul 13 15:12:06 2016 +0100
Revision:
3:768173a57492
Parent:
0:e1a608bb55e8 
further updates to mbed-dev-bin

Who changed what in which revision?

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