Jhon Plantikow / mbed

.

Dependents:   RTC

Transaction.h@0:88e313c910d0, 2015-08-13 (annotated)

Committer:
jhon309
Date:
Thu Aug 13 00:20:09 2015 +0000
Revision:
0:88e313c910d0
RTC Example

Who changed what in which revision?

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