Mistake on this page?
Report an issue in GitHub or email us
MeshInterface.h
1 /*
2  * Copyright (c) 2015 ARM Limited
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 /* @file MeshInterface.h Mesh network interface */
18 /** \addtogroup netinterface */
19 /** @{*/
20 
21 #ifndef MESH_INTERFACE_H
22 #define MESH_INTERFACE_H
23 
25 
26 
27 /** Common interface that is shared between mesh hardware
28  */
29 class MeshInterface : public virtual NetworkInterface {
30 public:
31  /** @copydoc NetworkInterface::meshInterface
32  */
34  {
35  return this;
36  }
37 
38  /** Get the default Mesh interface.
39  *
40  * This is provided as a weak method so applications can override.
41  * Default behavior is to get the target's default interface, if
42  * any.
43  *
44  * @return pointer to interface, if any.
45  */
47 
48 #if !defined(DOXYGEN_ONLY)
49 protected:
50 
51  /** Get the target's default Mesh interface.
52  *
53  * This is provided as a weak method so targets can override. The
54  * default implementation will invoke LoWPANNDInterface or ThreadInterface
55  * with the default NanostackRfPhy.
56  *
57  * @return pointer to interface, if any.
58  */
59  static MeshInterface *get_target_default_instance();
60 #endif //!defined(DOXYGEN_ONLY)
61 };
62 
63 
64 #endif
65 
66 /** @}*/
Network Interface base class.
Common interface that is shared between mesh hardware.
Definition: MeshInterface.h:29
MeshInterface * meshInterface() final
Return pointer to a MeshInterface.
Definition: MeshInterface.h:33
Common interface that is shared between network devices.
static MeshInterface * get_default_instance()
Get the default Mesh interface.
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.