HttpDebug.h

00001 /*****************************************************************************
00002 *
00003 *  HttpDebug.h
00004 *  Copyright (C) 2011 Texas Instruments Incorporated - http://www.ti.com/
00005 *
00006 *  Redistribution and use in source and binary forms, with or without
00007 *  modification, are permitted provided that the following conditions
00008 *  are met:
00009 *
00010 *    Redistributions of source code must retain the above copyright
00011 *    notice, this list of conditions and the following disclaimer.
00012 *
00013 *    Redistributions in binary form must reproduce the above copyright
00014 *    notice, this list of conditions and the following disclaimer in the
00015 *    documentation and/or other materials provided with the   
00016 *    distribution.
00017 *
00018 *    Neither the name of Texas Instruments Incorporated nor the names of
00019 *    its contributors may be used to endorse or promote products derived
00020 *    from this software without specific prior written permission.
00021 *
00022 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
00023 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
00024 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
00025 *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
00026 *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
00027 *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
00028 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
00029 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
00030 *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
00031 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
00032 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00033 *
00034 *****************************************************************************/
00035 #ifndef _HTTP_DEBUG_H_
00036 #define _HTTP_DEBUG_H_
00037 
00038 #include "HttpConfig.h"
00039 
00040 /** 
00041  * @defgroup HttpDebug Debugging routines
00042  * This module implements debug routines which enable debug traces to be sent to a logger
00043  * Note this module is only compiled if HTTP_CORE_ENABLE_DEBUG is defined in HttpConfig.h
00044  *
00045  * @{
00046  */
00047 
00048 /**
00049  * Send formatted debug trace to logger
00050  * @param pFormat The printf-style format to send
00051  * @param ... The rest of the parameters
00052  */
00053 void HttpDebug(const char* pFormat, ...);
00054 
00055 /**
00056  * Send string debug trace to logger
00057  * @param pString The string to send
00058  */
00059 void HttpDebugStr(const char* pString);
00060 
00061 /**
00062  * Assert that a certain condition is true
00063  * @param condition A value that must be nonzero
00064  */
00065 void HttpAssert(int condition);
00066 
00067 #endif // _HTTP_STRING_H_
00068