instance.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_INSTANCE_H_
#define OPENTHREAD_INSTANCE_H_

#include <stdlib.h>

#include <openthread/types.h>
#include <openthread/platform/logging.h>

#ifdef __cplusplus
extern "C" {
#endif

#ifdef OTDLL

OTAPI otApiInstance *OTCALL otApiInit(void);

OTAPI void OTCALL otApiFinalize(otApiInstance *aApiInstance);

OTAPI void OTCALL otFreeMemory(const void *aMem);

typedef void (OTCALL *otDeviceAvailabilityChangedCallback)(bool aAdded, const GUID *aDeviceGuid, void *aContext);

OTAPI void OTCALL otSetDeviceAvailabilityChangedCallback(otApiInstance *aApiInstance,
                                                         otDeviceAvailabilityChangedCallback aCallback, void *aCallbackContext);

OTAPI otDeviceList *OTCALL otEnumerateDevices(otApiInstance *aApiInstance);

OTAPI otInstance *OTCALL otInstanceInit(otApiInstance *aApiInstance, const GUID *aDeviceGuid);

OTAPI GUID OTCALL otGetDeviceGuid(otInstance *aInstance);

OTAPI uint32_t OTCALL otGetDeviceIfIndex(otInstance *aInstance);

OTAPI uint32_t OTCALL otGetCompartmentId(otInstance *aInstance);

#else // OTDLL

otInstance *otInstanceInit(void *aInstanceBuffer, size_t *aInstanceBufferSize);

otInstance *otInstanceInitSingle(void);

bool otInstanceIsInitialized(otInstance *aInstance);

void otInstanceFinalize(otInstance *aInstance);

#endif // OTDLL

typedef void (OTCALL *otStateChangedCallback)(uint32_t aFlags, void *aContext);

OTAPI otError OTCALL otSetStateChangedCallback(otInstance *aInstance, otStateChangedCallback aCallback,
                                               void *aContext);

OTAPI void OTCALL otRemoveStateChangeCallback(otInstance *aInstance, otStateChangedCallback aCallback,
                                              void *aCallbackContext);

OTAPI void OTCALL otInstanceReset(otInstance *aInstance);

OTAPI void OTCALL otInstanceFactoryReset(otInstance *aInstance);

otError otInstanceErasePersistentInfo(otInstance *aInstance);

otLogLevel otGetDynamicLogLevel(otInstance *aInstance);

otError otSetDynamicLogLevel(otInstance *aInstance, otLogLevel aLogLevel);

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

#endif  // OPENTHREAD_INSTANCE_H_