weave/src/system/SystemEvent.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
 *      This file enumerates and defines the different types of events
 *      generated at the Weave System Layer.
 */

#ifndef SYSTEMEVENT_H
#define SYSTEMEVENT_H

// Include headers
#include <SystemLayer/SystemConfig.h>

#if WEAVE_SYSTEM_CONFIG_USE_LWIP

namespace nl {
namespace Weave {
namespace System {

/**
 *  @typedef The basic type for all InetLayer events.
 *
 *  This is defined to a platform- or system-specific type.
 *
 */
typedef WEAVE_SYSTEM_CONFIG_LWIP_EVENT_TYPE EventType;

/**
 *  @typedef The basic object for all InetLayer events.
 *
 *  This is defined to a platform- or system-specific type.
 *
 */
typedef WEAVE_SYSTEM_CONFIG_LWIP_EVENT_OBJECT_TYPE Event;

/**
*   The Inet layer event type definitions.
*
*/
enum
{
    kEvent_ReleaseObj   = _WEAVE_SYSTEM_CONFIG_LWIP_EVENT(0), /**< The event for the drop of a SystemLayer object */
    kEvent_ScheduleWork = _WEAVE_SYSTEM_CONFIG_LWIP_EVENT(1), /**< The event for scheduling work on the System Layer's thread. */
};

/**
 *  Check to verify if an EventType is a valid one.
 *
 *  @param[in]  aEventType  Weave System Layer event type.
 *
 *  @return true if it falls within the enumerated range; otherwise, false.
 */
static inline bool IsEventOfType(EventType aType)
{
    return (aType >= kEvent_ReleaseObj && aType <= kEvent_ScheduleWork);
}

} // namespace System
} // namespace Weave
} // namespace nl

#endif // WEAVE_SYSTEM_CONFIG_USE_LWIP
#endif // defined(SYSTEMEVENT_H)