WebSVN – HelenOS – Diff – /branches/network/uspace/srv/net/app/print_error.h


/*
 * Copyright (c) 2009 Lukas Mejdrech
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - 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.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.
 */
 
/** @addtogroup net_app
 *  @{
 */
 
/** @file
 *  Generic application error printing functions.
 */
 
#ifndef __NET_APP_PRINT__
#define __NET_APP_PRINT__
 
/** Returns whether the error code may be an ICMP error code.
 *  @param[in] error_code The error code.
 *  @returns A value indicating whether the error code may be an ICMP error code.
 */
#define IS_ICMP_ERROR( error_code )     (( error_code ) > 0 )
 
/** Returns whether the error code may be socket error code.
 *  @param[in] error_code The error code.
 *  @returns A value indicating whether the error code may be a socket error code.
 */
#define IS_SOCKET_ERROR( error_code )   (( error_code ) < 0 )
 
/** Prints the error description.
 *  Supports ICMP and socket error codes.
 *  @param[in] output The description output stream. May be NULL.
 *  @param[in] error_code The error code.
 *  @param[in] prefix The error description prefix. May be NULL.
 *  @param[in] suffix The error description suffix. May be NULL.
 */
void print_error( FILE * output, int error_code, const char * prefix, const char * suffix );
 
/** Prints the specific ICMP error description.
 *  @param[in] output The description output stream. May be NULL.
 *  @param[in] error_code The ICMP error code.
 *  @param[in] prefix The error description prefix. May be NULL.
 *  @param[in] suffix The error description suffix. May be NULL.
 */
void icmp_print_error( FILE * output, int error_code, const char * prefix, const char * suffix );
 
/** Prints the specific socket error description.
 *  @param[in] output The description output stream. May be NULL.
 *  @param[in] error_code The socket error code.
 *  @param[in] prefix The error description prefix. May be NULL.
 *  @param[in] suffix The error description suffix. May be NULL.
 */
void socket_print_error( FILE * output, int error_code, const char * prefix, const char * suffix );
 
#endif
 
/** @}
 */
 

Subversion Repositories HelenOS

(root)/branches/network/uspace/srv/net/app/print_error.h – Rev 4720 → 4756

Rev 4720		Rev 4756
1	/*	1	/*
2	* Copyright (c) 2009 Lukas Mejdrech	2	* Copyright (c) 2009 Lukas Mejdrech
3	* All rights reserved.	3	* All rights reserved.
4	*	4	*
5	* Redistribution and use in source and binary forms, with or without	5	* Redistribution and use in source and binary forms, with or without
6	* modification, are permitted provided that the following conditions	6	* modification, are permitted provided that the following conditions
7	* are met:	7	* are met:
8	*	8	*
9	* - Redistributions of source code must retain the above copyright	9	* - Redistributions of source code must retain the above copyright
10	* notice, this list of conditions and the following disclaimer.	10	* notice, this list of conditions and the following disclaimer.
11	* - Redistributions in binary form must reproduce the above copyright	11	* - Redistributions in binary form must reproduce the above copyright
12	* notice, this list of conditions and the following disclaimer in the	12	* notice, this list of conditions and the following disclaimer in the
13	* documentation and/or other materials provided with the distribution.	13	* documentation and/or other materials provided with the distribution.
14	* - The name of the author may not be used to endorse or promote products	14	* - The name of the author may not be used to endorse or promote products
15	* derived from this software without specific prior written permission.	15	* derived from this software without specific prior written permission.
16	*	16	*
17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR	17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES	18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.	19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,	20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT	21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,	22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY	23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT	24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF	25	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.	26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27	*/	27	*/
28		28
29	/** @addtogroup net_app	29	/** @addtogroup net_app
30	* @{	30	* @{
31	*/	31	*/
32		32
33	/** @file	33	/** @file
34	* Generic application error printing functions.	34	* Generic application error printing functions.
35	*/	35	*/
36		36
37	#ifndef __NET_APP_PRINT__	37	#ifndef __NET_APP_PRINT__
38	#define __NET_APP_PRINT__	38	#define __NET_APP_PRINT__
39		39
40	/** Returns whether the error code may be an ICMP error code.	40	/** Returns whether the error code may be an ICMP error code.
41	* @param error_code The error code. Input parameter.	41	* @param[in] error_code The error code.
42	* @returns A value indicating whether the error code may be an ICMP error code.	42	* @returns A value indicating whether the error code may be an ICMP error code.
43	*/	43	*/
44	#define IS_ICMP_ERROR( error_code ) (( error_code ) > 0 )	44	#define IS_ICMP_ERROR( error_code ) (( error_code ) > 0 )
45		45
46	/** Returns whether the error code may be socket error code.	46	/** Returns whether the error code may be socket error code.
47	* @param error_code The error code. Input parameter.	47	* @param[in] error_code The error code.
48	* @returns A value indicating whether the error code may be a socket error code.	48	* @returns A value indicating whether the error code may be a socket error code.
49	*/	49	*/
50	#define IS_SOCKET_ERROR( error_code ) (( error_code ) < 0 )	50	#define IS_SOCKET_ERROR( error_code ) (( error_code ) < 0 )
51		51
52	/** Prints the error description.	52	/** Prints the error description.
53	* Supports ICMP and socket error codes.	53	* Supports ICMP and socket error codes.
54	* @param output The description output stream. May be NULL. Input parameter.	54	* @param[in] output The description output stream. May be NULL.
55	* @param error_code The error code. Input parameter.	55	* @param[in] error_code The error code.
56	* @param prefix The error description prefix. May be NULL. Input parameter.	56	* @param[in] prefix The error description prefix. May be NULL.
57	* @param suffix The error description suffix. May be NULL. Input parameter.	57	* @param[in] suffix The error description suffix. May be NULL.
58	*/	58	*/
59	void print_error( FILE * output, int error_code, const char * prefix, const char * suffix );	59	void print_error( FILE * output, int error_code, const char * prefix, const char * suffix );
60		60
61	/** Prints the specific ICMP error description.	61	/** Prints the specific ICMP error description.
62	* @param output The description output stream. May be NULL. Input parameter.	62	* @param[in] output The description output stream. May be NULL.
63	* @param error_code The ICMP error code. Input parameter.	63	* @param[in] error_code The ICMP error code.
64	* @param prefix The error description prefix. May be NULL. Input parameter.	64	* @param[in] prefix The error description prefix. May be NULL.
65	* @param suffix The error description suffix. May be NULL. Input parameter.	65	* @param[in] suffix The error description suffix. May be NULL.
66	*/	66	*/
67	void icmp_print_error( FILE * output, int error_code, const char * prefix, const char * suffix );	67	void icmp_print_error( FILE * output, int error_code, const char * prefix, const char * suffix );
68		68
69	/** Prints the specific socket error description.	69	/** Prints the specific socket error description.
70	* @param output The description output stream. May be NULL. Input parameter.	70	* @param[in] output The description output stream. May be NULL.
71	* @param error_code The socket error code. Input parameter.	71	* @param[in] error_code The socket error code.
72	* @param prefix The error description prefix. May be NULL. Input parameter.	72	* @param[in] prefix The error description prefix. May be NULL.
73	* @param suffix The error description suffix. May be NULL. Input parameter.	73	* @param[in] suffix The error description suffix. May be NULL.
74	*/	74	*/
75	void socket_print_error( FILE * output, int error_code, const char * prefix, const char * suffix );	75	void socket_print_error( FILE * output, int error_code, const char * prefix, const char * suffix );
76		76
77	#endif	77	#endif
78		78
79	/** @}	79	/** @}
80	*/	80	*/
81		81