/*---------------------------------------------------------------------------*
  Project:  Horizon
  File:     rdt_Misc.h

  Copyright (C) Nintendo.  All rights reserved.

  These coded instructions, statements, and computer programs contain
  proprietary information of Nintendo of America Inc. and/or Nintendo
  Company Ltd., and are protected by Federal copyright law.  They may
  not be disclosed to third parties or copied or duplicated in any form,
  in whole or in part, without the prior written consent of Nintendo.

  $Rev: 54504 $
 *---------------------------------------------------------------------------*/

////#include <stdafx.h>

#ifndef NN_RDT_MISC_H_
#define NN_RDT_MISC_H_


#include <nn/rdt/rdt_define.h>

#include <nn/types.h>
#include <nn/Result.h>


namespace nn { namespace rdt {

/*!
    @ingroup  nn_rdt
    @defgroup nn_rdt_api  Reliable Local Communication (RDT) API
    @brief  This is a list of Reliable Local Communication (RDT) library API members. (Includes only C++ API members.)
    @{
*/

    const bit32 LOG_LEVEL_NONE = 0x00000000;  //!< Constant that indicates that a log is not output in any way.
    const bit32 LOG_LEVEL_ALL  = 0xffffffff;  //!< Constant that indicates that all logs are output.

/*!
    @brief  Configures the log output level for the Reliable Local Communication (RDT) library.

    By default, the RDT library is configured to not output a log.
    When investigating bugs in the RDT library or in similar scenarios, call <tt>nn::rdt::SetLogLevel(nn::rdt::LOG_LEVEL_ALL);</tt> in advance to enable log output. This function helps when debugging the RDT library.

    At present, there are only two output level settings: no output log at all, and a complete log. In the future, we may provide more detailed options for log output.

    @param[in] level  Specifies an argument to control the log output.

    @return  Returns the value of the <tt>@ref nn::Result::IsSuccess</tt> function when a valid argument is specified.
    Currently, the valid arguments are <tt>@ref LOG_LEVEL_NONE</tt> and <tt>@ref LOG_LEVEL_ALL</tt>.
    Returns <tt>@ref ResultInvalidValue</tt> when an invalid argument is specified.
    
    
    
    
*/
    nn::Result SetLogLevel(bit32 level);


/*!
    @brief  Gets the log output level configured for the RDT library.

    By default, the RDT library is configured to not output a log.

    @return  Returns the current log output level.
*/
    bit32 GetLogLevel(void);


//! @}

}} // namespace nn::rdt

#endif  // end of NN_RDT_MISC_H_