weave/src/inet/InetFaultInjection.h

/*
 *
 *    Copyright (c) 2016-2017 Nest Labs, Inc.
 *    All rights reserved.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */

/**
 *    @file
 *      Header file for the fault-injection utilities for Inet.
 */

#ifndef INET_FAULT_INJECTION_H_
#define INET_FAULT_INJECTION_H_

#include <nlfaultinjection.hpp>

#include <InetLayer/InetConfig.h>

#include <Weave/Support/NLDLLUtil.h>

#if INET_CONFIG_PROVIDE_OBSOLESCENT_INTERFACES
#include <SystemLayer/SystemFaultInjection.h>
#endif // INET_CONFIG_PROVIDE_OBSOLESCENT_INTERFACES

namespace nl {
namespace Inet {
namespace FaultInjection {

/**
 * @brief   Fault injection points
 *
 * @details
 * Each point in the code at which a fault can be injected
 * is identified by a member of this enum.
 */
typedef enum
{
    kFault_DNSResolverNew,             /**< Fail the allocation of a DNSResolver object */
    kFault_Send,                       /**< Fail sending a message over TCP or UDP */
    kFault_SendNonCritical,            /**< Fail sending a UDP message returning an error considered non-critical by WRMP */
    kFault_NumItems,
} InetFaultInjectionID;

NL_DLL_EXPORT nl::FaultInjection::Manager &GetManager(void);

} // namespace FaultInjection
} // namespace Inet
} // namespace nl

#if INET_CONFIG_TEST

/**
 * Execute the statements included if the Inet fault is
 * to be injected.
 *
 * @param[in] aFaultID      An Inet fault-injection id
 * @param[in] aStatements   Statements to be executed if the fault is enabled.
 */
#define INET_FAULT_INJECT( aFaultID, aStatement ) \
        nlFAULT_INJECT(nl::Inet::FaultInjection::GetManager(), aFaultID, aStatement)

#else

#define INET_FAULT_INJECT( aFaultID, aStatement )

#endif


#endif // INET_FAULT_INJECTION_H_