Kev Mann / mbed-dev-OS5_10_4

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

features/netsocket/MeshInterface.h@0:38ceb79fef03, 2018-11-28 (annotated)

Committer:
kevman
Date:
Wed Nov 28 15:10:15 2018 +0000
Revision:
0:38ceb79fef03
RTC modified

Who changed what in which revision?

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