Marco Zecchini
/
Example_RTOS
Rtos API example
Embed:
(wiki syntax)
Show/hide line numbers
ThreadInterface.h
00001 /* 00002 * Copyright (c) 2015 ARM Limited. All rights reserved. 00003 * SPDX-License-Identifier: Apache-2.0 00004 * Licensed under the Apache License, Version 2.0 (the License); you may 00005 * not use this file except in compliance with the License. 00006 * You may obtain a copy of the License at 00007 * 00008 * http://www.apache.org/licenses/LICENSE-2.0 00009 * 00010 * Unless required by applicable law or agreed to in writing, software 00011 * distributed under the License is distributed on an AS IS BASIS, WITHOUT 00012 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 00013 * See the License for the specific language governing permissions and 00014 * limitations under the License. 00015 */ 00016 00017 #ifndef THREADINTERFACE_H 00018 #define THREADINTERFACE_H 00019 00020 #include "MeshInterfaceNanostack.h" 00021 00022 class ThreadInterface : public MeshInterfaceNanostack { 00023 public: 00024 00025 /** Create an uninitialized LoWPANNDInterface 00026 * 00027 * Must initialize to initialize the mesh on a phy. 00028 */ 00029 ThreadInterface() : MeshInterfaceNanostack() { } 00030 00031 /** Create an initialized MeshInterface 00032 * 00033 */ 00034 ThreadInterface(NanostackRfPhy *phy) : MeshInterfaceNanostack(phy) { } 00035 00036 nsapi_error_t initialize(NanostackRfPhy *phy); 00037 virtual int connect(); 00038 virtual int disconnect(); 00039 private: 00040 /* 00041 * \brief Initialization of the interface. 00042 * \return MESH_ERROR_NONE on success. 00043 * \return MESH_ERROR_PARAM when input parameters are illegal (also in case when RF device is already associated to other interface) 00044 * \return MESH_ERROR_MEMORY in case of memory error 00045 * \return MESH_ERROR_UNKNOWN in other error cases 00046 */ 00047 mesh_error_t init(); 00048 /** 00049 * \brief Connect interface to the mesh network 00050 * \return MESH_ERROR_NONE on success. 00051 * \return MESH_ERROR_PARAM in case of illegal parameters. 00052 * \return MESH_ERROR_MEMORY in case of memory error. 00053 * \return MESH_ERROR_STATE if interface is already connected to network. 00054 * \return MESH_ERROR_UNKNOWN in case of unspecified error. 00055 * */ 00056 mesh_error_t mesh_connect(); 00057 00058 /** 00059 * \brief Disconnect interface from the mesh network 00060 * \return MESH_ERROR_NONE on success. 00061 * \return MESH_ERROR_UNKNOWN in case of error. 00062 * */ 00063 mesh_error_t mesh_disconnect(); 00064 00065 /** 00066 * \brief Read own global IP address 00067 * 00068 * \param address is where the IP address will be copied 00069 * \param len is the length of the address buffer, must be at least 40 bytes 00070 * \return true if address is read successfully, false otherwise 00071 */ 00072 virtual bool getOwnIpAddress(char *address, int8_t len); 00073 }; 00074 00075 #endif // THREADINTERFACE_H
Generated on Sun Jul 17 2022 08:25:32 by 1.7.2