0.01.00
context.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017, 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 
34 #ifndef CONTEXT_HPP_
35 #define CONTEXT_HPP_
36 
37 #include "openthread-core-config.h"
38 
39 #include <openthread/platform/toolchain.h>
40 
41 #include "openthread-core-config.h"
42 
43 namespace ot {
44 
61 class Context
62 {
63 public:
64 
65 #if OPENTHREAD_ENABLE_MULTIPLE_INSTANCES
66 
72  void *GetContext(void) const { return mContext; }
73 #endif
74 
75 protected:
82  Context(void *aContext)
83 #if OPENTHREAD_ENABLE_MULTIPLE_INSTANCES
84  : mContext(aContext)
85 #endif
86  {
87  OT_UNUSED_VARIABLE(aContext);
88  }
89 
90 private:
91 #if OPENTHREAD_ENABLE_MULTIPLE_INSTANCES
92  void *mContext;
93 #endif
94 };
95 
101 } // namespace ot
102 
103 #endif // CONTEXT_HPP_
Definition: cli.cpp:90
Context(void *aContext)
This constructor initializes the context object.
Definition: context.hpp:82
#define OT_UNUSED_VARIABLE(VARIABLE)
Suppress unused variable warning in specific toolchains.
Definition: toolchain.h:263
This class implements definitions for maintaining a pointer to arbitrary context information.
Definition: context.hpp:61
This file includes compile-time configuration constants for OpenThread.