thread.h

Go to the documentation of this file.

/*
 *  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.
 */

#ifndef OPENTHREAD_THREAD_H_
#define OPENTHREAD_THREAD_H_

#include <openthread/link.h>
#include <openthread/message.h>
#include <openthread/types.h>

#ifdef __cplusplus
extern "C" {
#endif

OTAPI otError OTCALL otThreadSetEnabled(otInstance *aInstance, bool aEnabled);

OTAPI bool OTCALL otThreadGetAutoStart(otInstance *aInstance);

OTAPI otError OTCALL otThreadSetAutoStart(otInstance *aInstance, bool aStartAutomatically);

OTAPI bool OTCALL otThreadIsSingleton(otInstance *aInstance);

OTAPI otError OTCALL otThreadDiscover(otInstance *aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner,
                                      bool aEnableEui64Filtering, otHandleActiveScanResult aCallback,
                                      void *aCallbackContext);

OTAPI bool OTCALL otThreadIsDiscoverInProgress(otInstance *aInstance);

OTAPI uint32_t OTCALL otThreadGetChildTimeout(otInstance *aInstance);

OTAPI void OTCALL otThreadSetChildTimeout(otInstance *aInstance, uint32_t aTimeout);

OTAPI const uint8_t *OTCALL otThreadGetExtendedPanId(otInstance *aInstance);

OTAPI otError OTCALL otThreadSetExtendedPanId(otInstance *aInstance, const uint8_t *aExtendedPanId);

OTAPI otError OTCALL otThreadGetLeaderRloc(otInstance *aInstance, otIp6Address *aLeaderRloc);

OTAPI otLinkModeConfig OTCALL otThreadGetLinkMode(otInstance *aInstance);

OTAPI otError OTCALL otThreadSetLinkMode(otInstance *aInstance, otLinkModeConfig aConfig);

OTAPI const otMasterKey *OTCALL otThreadGetMasterKey(otInstance *aInstance);

OTAPI otError OTCALL otThreadSetMasterKey(otInstance *aInstance, const otMasterKey *aKey);

OTAPI const otIp6Address *OTCALL otThreadGetMeshLocalEid(otInstance *aInstance);

OTAPI const uint8_t *OTCALL otThreadGetMeshLocalPrefix(otInstance *aInstance);

OTAPI otError OTCALL otThreadSetMeshLocalPrefix(otInstance *aInstance, const uint8_t *aMeshLocalPrefix);

const otIp6Address *otThreadGetLinkLocalIp6Address(otInstance *aInstance);

OTAPI const char *OTCALL otThreadGetNetworkName(otInstance *aInstance);

OTAPI otError OTCALL otThreadSetNetworkName(otInstance *aInstance, const char *aNetworkName);

OTAPI uint32_t OTCALL otThreadGetKeySequenceCounter(otInstance *aInstance);

OTAPI void OTCALL otThreadSetKeySequenceCounter(otInstance *aInstance, uint32_t aKeySequenceCounter);

OTAPI uint32_t OTCALL otThreadGetKeySwitchGuardTime(otInstance *aInstance);

OTAPI void OTCALL otThreadSetKeySwitchGuardTime(otInstance *aInstance, uint32_t aKeySwitchGuardTime);

OTAPI otError OTCALL otThreadBecomeDetached(otInstance *aInstance);

OTAPI otError OTCALL otThreadBecomeChild(otInstance *aInstance);

OTAPI otError OTCALL otThreadGetNextNeighborInfo(otInstance *aInstance, otNeighborInfoIterator *aIterator,
                                                 otNeighborInfo *aInfo);

OTAPI otDeviceRole OTCALL otThreadGetDeviceRole(otInstance *aInstance);

OTAPI otError OTCALL otThreadGetLeaderData(otInstance *aInstance, otLeaderData *aLeaderData);

OTAPI uint8_t OTCALL otThreadGetLeaderRouterId(otInstance *aInstance);

OTAPI uint8_t OTCALL otThreadGetLeaderWeight(otInstance *aInstance);

OTAPI uint32_t OTCALL otThreadGetPartitionId(otInstance *aInstance);

OTAPI uint16_t OTCALL otThreadGetRloc16(otInstance *aInstance);

OTAPI otError OTCALL otThreadGetParentInfo(otInstance *aInstance, otRouterInfo *aParentInfo);

OTAPI otError OTCALL otThreadGetParentAverageRssi(otInstance *aInstance, int8_t *aParentRssi);

OTAPI otError OTCALL otThreadGetParentLastRssi(otInstance *aInstance, int8_t *aLastRssi);

typedef void (*otReceiveDiagnosticGetCallback)(otMessage *aMessage, const otMessageInfo *aMessageInfo,
                                               void *aContext);

void otThreadSetReceiveDiagnosticGetCallback(otInstance *aInstance, otReceiveDiagnosticGetCallback aCallback,
                                             void *aCallbackContext);

OTAPI otError OTCALL otThreadSendDiagnosticGet(otInstance *aInstance, const otIp6Address *aDestination,
                                               const uint8_t aTlvTypes[], uint8_t aCount);

OTAPI otError OTCALL otThreadSendDiagnosticReset(otInstance *aInstance, const otIp6Address *aDestination,
                                                 const uint8_t aTlvTypes[], uint8_t aCount);

OTAPI const otIpCounters *OTCALL otThreadGetIp6Counters(otInstance *aInstance);

#ifdef __cplusplus
}  // extern "C"
#endif

#endif  // OPENTHREAD_THREAD_H_