Doug Anson / mbedConnectorInterfaceWithDM

mbed Connector Interface simplification API on top of mbed-client

Fork of mbedConnectorInterfaceV3 by Doug Anson

NOTE:

This repo has been replaced with https://github.com/ARMmbed/mbedConnectorInterface. No further updates will occur with this repo. Please use the github repo instead. Thanks!

mbed-connector-interface/DataWrapper.h@127:b4a661ff6fb9, 2017-09-26 (annotated)

Committer:
ansond
Date:
Tue Sep 26 16:01:31 2017 +0000
Revision:
127:b4a661ff6fb9
Parent:
33:1d0b855df5a5 
minor re-ordering of FCC init

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ansond 0:1f1f55e73248 1 /**
ansond 0:1f1f55e73248 2 * @file DataWrapper.h
ansond 0:1f1f55e73248 3 * @brief mbed CoAP Endpoint Data Wrapper class (header)
ansond 0:1f1f55e73248 4 * @author Doug Anson
ansond 0:1f1f55e73248 5 * @version 1.0
ansond 0:1f1f55e73248 6 * @see
ansond 0:1f1f55e73248 7 *
ansond 0:1f1f55e73248 8 * Copyright (c) 2014
ansond 0:1f1f55e73248 9 *
ansond 0:1f1f55e73248 10 * Licensed under the Apache License, Version 2.0 (the "License");
ansond 0:1f1f55e73248 11 * you may not use this file except in compliance with the License.
ansond 0:1f1f55e73248 12 * You may obtain a copy of the License at
ansond 0:1f1f55e73248 13 *
ansond 0:1f1f55e73248 14 * http://www.apache.org/licenses/LICENSE-2.0
ansond 0:1f1f55e73248 15 *
ansond 0:1f1f55e73248 16 * Unless required by applicable law or agreed to in writing, software
ansond 0:1f1f55e73248 17 * distributed under the License is distributed on an "AS IS" BASIS,
ansond 0:1f1f55e73248 18 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ansond 0:1f1f55e73248 19 * See the License for the specific language governing permissions and
ansond 0:1f1f55e73248 20 * limitations under the License.
ansond 0:1f1f55e73248 21 */
ansond 0:1f1f55e73248 22
ansond 0:1f1f55e73248 23 #ifndef __DATA_WRAPPER_H__
ansond 0:1f1f55e73248 24 #define __DATA_WRAPPER_H__
ansond 0:1f1f55e73248 25
ansond 33:1d0b855df5a5 26 // mbedConnectorInterface configuration
ansond 33:1d0b855df5a5 27 #include "mbed-connector-interface/mbedConnectorInterface.h"
ansond 33:1d0b855df5a5 28
ansond 0:1f1f55e73248 29 // mbed support
ansond 33:1d0b855df5a5 30 #if defined(MCI_USE_YOTTA)
ansond 33:1d0b855df5a5 31 // mbed support
ansond 33:1d0b855df5a5 32 #include "mbed-drivers/mbed.h"
ansond 33:1d0b855df5a5 33 #else
ansond 33:1d0b855df5a5 34 // mbed support
ansond 33:1d0b855df5a5 35 #include "mbed.h"
ansond 33:1d0b855df5a5 36 #endif
ansond 0:1f1f55e73248 37
ansond 0:1f1f55e73248 38 class DataWrapper {
ansond 0:1f1f55e73248 39 public:
ansond 0:1f1f55e73248 40 /**
ansond 0:1f1f55e73248 41 Default constructor
ansond 0:1f1f55e73248 42 @param data input the buffer to use for operations
ansond 0:1f1f55e73248 43 @param data_length input the data length
ansond 0:1f1f55e73248 44 */
ansond 0:1f1f55e73248 45 DataWrapper(uint8_t *data,int data_length);
ansond 0:1f1f55e73248 46
ansond 0:1f1f55e73248 47 /**
ansond 0:1f1f55e73248 48 Default constructor (alloc)
ansond 0:1f1f55e73248 49 @param data_length input the data length (alloc)
ansond 0:1f1f55e73248 50 */
ansond 0:1f1f55e73248 51 DataWrapper(int data_length);
ansond 0:1f1f55e73248 52
ansond 0:1f1f55e73248 53 /**
ansond 0:1f1f55e73248 54 Default copy constructor
ansond 0:1f1f55e73248 55 @param data input the DataWrapper to copy
ansond 0:1f1f55e73248 56 */
ansond 0:1f1f55e73248 57 DataWrapper(const DataWrapper &data);
ansond 0:1f1f55e73248 58
ansond 0:1f1f55e73248 59 /**
ansond 0:1f1f55e73248 60 Destructor
ansond 0:1f1f55e73248 61 */
ansond 0:1f1f55e73248 62 virtual ~DataWrapper();
ansond 0:1f1f55e73248 63
ansond 0:1f1f55e73248 64 /**
ansond 0:1f1f55e73248 65 Wrap the data (trivial in base class)
ansond 0:1f1f55e73248 66 @param data input the data to wrap
ansond 0:1f1f55e73248 67 @param data_length input the length of the data to wrap
ansond 0:1f1f55e73248 68 */
ansond 0:1f1f55e73248 69 virtual void wrap(uint8_t *data,int data_length);
ansond 0:1f1f55e73248 70
ansond 0:1f1f55e73248 71 /**
ansond 0:1f1f55e73248 72 Unwrap the data (trivial in base class)
ansond 0:1f1f55e73248 73 @param data input the data to unwrap
ansond 0:1f1f55e73248 74 @param data_length input the length of the data to unwrap
ansond 0:1f1f55e73248 75 */
ansond 0:1f1f55e73248 76 virtual void unwrap(uint8_t *data,int data_length);
ansond 0:1f1f55e73248 77
ansond 0:1f1f55e73248 78 /**
ansond 0:1f1f55e73248 79 Get the wrap/unwrap result
ansond 0:1f1f55e73248 80 @return pointer to the data buffer of DataWrapper containing the wrap/unwrap result
ansond 0:1f1f55e73248 81 */
ansond 0:1f1f55e73248 82 uint8_t *get() { return this->m_data; }
ansond 0:1f1f55e73248 83
ansond 0:1f1f55e73248 84 /**
ansond 0:1f1f55e73248 85 Get the wrap/unwrap result length
ansond 0:1f1f55e73248 86 @return length of the wrap/unwrap data result
ansond 0:1f1f55e73248 87 */
ansond 0:1f1f55e73248 88 int length() { return this->m_data_length; }
ansond 0:1f1f55e73248 89
ansond 0:1f1f55e73248 90 /**
ansond 0:1f1f55e73248 91 Reset the wrapper
ansond 0:1f1f55e73248 92 */
ansond 0:1f1f55e73248 93 void reset();
ansond 0:1f1f55e73248 94
ansond 0:1f1f55e73248 95 /**
ansond 0:1f1f55e73248 96 Set the new application key
ansond 0:1f1f55e73248 97 @param appkey input the new appkey (encrypted) to set
ansond 0:1f1f55e73248 98 @param appkey_length input the new appkey (encrypted) length
ansond 0:1f1f55e73248 99 */
ansond 0:1f1f55e73248 100 virtual void setAppKey(uint8_t *appkey,int appkey_length);
ansond 0:1f1f55e73248 101
ansond 0:1f1f55e73248 102 protected:
ansond 0:1f1f55e73248 103 uint8_t *m_data;
ansond 0:1f1f55e73248 104
ansond 0:1f1f55e73248 105 private:
ansond 0:1f1f55e73248 106 bool m_alloced;
ansond 0:1f1f55e73248 107 int m_data_length;
ansond 0:1f1f55e73248 108 int m_data_length_max;
ansond 0:1f1f55e73248 109 };
ansond 0:1f1f55e73248 110
ansond 0:1f1f55e73248 111 #endif // __DATA_WRAPPER_H__
ansond 0:1f1f55e73248 112