1 /* 2 * Copyright (c) 2019, The OpenThread Authors. 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are met: 7 * 1. Redistributions of source code must retain the above copyright 8 * notice, this list of conditions and the following disclaimer. 9 * 2. Redistributions in binary form must reproduce the above copyright 10 * notice, this list of conditions and the following disclaimer in the 11 * documentation and/or other materials provided with the distribution. 12 * 3. Neither the name of the copyright holder nor the 13 * names of its contributors may be used to endorse or promote products 14 * derived from this software without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 26 * POSSIBILITY OF SUCH DAMAGE. 27 */ 28 29 /** 30 * @file 31 * This file includes definitions of frame context used for indirect transmission. 32 */ 33 34 #ifndef INDIRECT_SENDER_FRAME_CONTEXT_HPP_ 35 #define INDIRECT_SENDER_FRAME_CONTEXT_HPP_ 36 37 #include "openthread-core-config.h" 38 39 #include <stdint.h> 40 41 namespace ot { 42 43 /** 44 * @addtogroup core-mesh-forwarding 45 * 46 * @brief 47 * This module includes definitions frame context used by indirect sender. 48 * 49 * @{ 50 */ 51 52 /** 53 * Defines the `FrameContext` type. 54 * 55 * This is the base class for `IndirectSender`. 56 */ 57 class IndirectSenderBase 58 { 59 public: 60 /** 61 * Defines the frame context used by `IndirectSender`. 62 * 63 * Specifies all the info that `IndirectSender` requires to be saved along with a prepared frame for 64 * indirect transmission. `IndirectSender` is designed to contain the common code for handling of indirect 65 * transmission to sleepy children and be able to interface to different lower-layer implementation of 66 * `DataPollHandler`. While the `FrameContext` is defined by the `IndirectSender` itself, the lower-layer 67 * (`DataPollHandler`) is expected to provide the buffer/object for context to be stored (it is provided from the 68 * lower-layer callback asking for a frame to be prepared). This model allows different implementations of 69 * `DataPollHandler` to adopt different strategies on how to save the context. 70 */ 71 struct FrameContext 72 { 73 friend class IndirectSender; 74 friend class CslTxScheduler; 75 76 private: 77 uint16_t mMessageNextOffset; ///< The next offset into the message associated with the prepared frame. 78 }; 79 }; 80 81 /** 82 * @} 83 */ 84 85 } // namespace ot 86 87 #endif // INDIRECT_SENDER_FRAME_CONTEXT_HPP_ 88