| /* |
| * Copyright (c) 2016, The OpenThread Authors. |
| * All rights reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions are met: |
| * 1. Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * 2. Redistributions in binary form must reproduce the above copyright |
| * notice, this list of conditions and the following disclaimer in the |
| * documentation and/or other materials provided with the distribution. |
| * 3. Neither the name of the copyright holder nor the |
| * names of its contributors may be used to endorse or promote products |
| * derived from this software without specific prior written permission. |
| * |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
| * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
| * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
| * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
| * POSSIBILITY OF SUCH DAMAGE. |
| */ |
| |
| /** |
| * @file |
| * This file includes definitions for the Joiner role. |
| */ |
| |
| #ifndef JOINER_HPP_ |
| #define JOINER_HPP_ |
| |
| #include <openthread/joiner.h> |
| |
| #include "coap/coap.hpp" |
| #include "coap/coap_header.hpp" |
| #include "coap/coap_secure.hpp" |
| #include "common/crc16.hpp" |
| #include "common/locator.hpp" |
| #include "common/message.hpp" |
| #include "meshcop/dtls.hpp" |
| #include "meshcop/meshcop_tlvs.hpp" |
| #include "net/udp6.hpp" |
| |
| namespace ot { |
| |
| class ThreadNetif; |
| |
| namespace MeshCoP { |
| |
| class Joiner: public ThreadNetifLocator |
| { |
| public: |
| /** |
| * This constructor initializes the Joiner object. |
| * |
| * @param[in] aThreadNetif A reference to the Thread network interface. |
| * |
| */ |
| Joiner(ThreadNetif &aThreadNetif); |
| |
| /** |
| * This method starts the Joiner service. |
| * |
| * @param[in] aPSKd A pointer to the PSKd. |
| * @param[in] aProvisioningUrl A pointer to the Provisioning URL (may be NULL). |
| * @param[in] aVendorName A pointer to the Vendor Name (must be static). |
| * @param[in] aVendorModel A pointer to the Vendor Model (must be static). |
| * @param[in] aVendorSwVersion A pointer to the Vendor SW Version (must be static). |
| * @param[in] aVendorData A pointer to the Vendor Data (must be static). |
| * @param[in] aCallback A pointer to a function that is called when the join operation completes. |
| * @param[in] aContext A pointer to application-specific context. |
| * |
| * @retval OT_ERROR_NONE Successfully started the Joiner service. |
| * |
| */ |
| otError Start(const char *aPSKd, const char *aProvisioningUrl, |
| const char *aVendorName, const char *aVendorModel, |
| const char *aVendorSwVersion, const char *aVendorData, |
| otJoinerCallback aCallback, void *aContext); |
| |
| /** |
| * This method stops the Joiner service. |
| * |
| * @retval OT_ERROR_NONE Successfully stopped the Joiner service. |
| * |
| */ |
| otError Stop(void); |
| |
| private: |
| enum |
| { |
| kConfigExtAddressDelay = 100, ///< milliseconds |
| kTimeout = 4000, ///< milliseconds |
| }; |
| |
| static void HandleDiscoverResult(otActiveScanResult *aResult, void *aContext); |
| void HandleDiscoverResult(otActiveScanResult *aResult); |
| |
| static void HandleTimer(Timer &aTimer); |
| void HandleTimer(void); |
| |
| void Close(void); |
| void Complete(otError aError); |
| |
| static void HandleSecureCoapClientConnect(bool aConnected, void *aContext); |
| void HandleSecureCoapClientConnect(bool aConnected); |
| |
| void SendJoinerFinalize(void); |
| static void HandleJoinerFinalizeResponse(void *aContext, otCoapHeader *aHeader, otMessage *aMessage, |
| const otMessageInfo *aMessageInfo, otError aResult); |
| void HandleJoinerFinalizeResponse(Coap::Header *aHeader, Message *aMessage, |
| const Ip6::MessageInfo *aMessageInfo, otError aResult); |
| |
| static void HandleJoinerEntrust(void *aContext, otCoapHeader *aHeader, otMessage *aMessage, |
| const otMessageInfo *aMessageInfo); |
| void HandleJoinerEntrust(Coap::Header &aHeader, Message &aMessage, const Ip6::MessageInfo &aMessageInfo); |
| void SendJoinerEntrustResponse(const Coap::Header &aRequestHeader, const Ip6::MessageInfo &aRequestInfo); |
| |
| static Joiner &GetOwner(const Context &aContext); |
| |
| enum State |
| { |
| kStateIdle = 0, |
| kStateDiscover = 1, |
| kStateConnect = 2, |
| kStateConnected = 3, |
| kStateEntrust = 4, |
| kStateJoined = 5, |
| }; |
| State mState; |
| |
| otJoinerCallback mCallback; |
| void *mContext; |
| |
| uint16_t mCcitt; |
| uint16_t mAnsi; |
| |
| uint8_t mJoinerRouterChannel; |
| uint16_t mJoinerRouterPanId; |
| uint16_t mJoinerUdpPort; |
| Mac::ExtAddress mJoinerRouter; |
| |
| const char *mVendorName; |
| const char *mVendorModel; |
| const char *mVendorSwVersion; |
| const char *mVendorData; |
| |
| Timer mTimer; |
| Coap::Resource mJoinerEntrust; |
| }; |
| |
| } // namespace MeshCoP |
| } // namespace ot |
| |
| #endif // JOINER_HPP_ |