erkin yucel / mbed-os

mbed os with nrf51 internal bandgap enabled to read battery level

Dependents:   BLE_file_test BLE_Blink ExternalEncoder

platform/Transaction.h@0:f269e3021894, 2016-10-23 (annotated)

Committer:
elessair
Date:
Sun Oct 23 15:10:02 2016 +0000
Revision:
0:f269e3021894
Initial commit

Who changed what in which revision?

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