WebSVN – HelenOS – Diff – /branches/network/uspace/srv/net/err.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
 *  @{
 */
 
/** @file
 *  Common error processing codes and routines.
 */
 
#ifndef __NET_ERR_H__
#define __NET_ERR_H__
 
#include <errno.h>
 
/** An actual stored error code.
 */
#define ERROR_CODE                  error_check_return_value
 
/** An error processing routines declaration.
 *  This has to be declared in the block where the error processing is desired.
 */
#define ERROR_DECLARE               int ERROR_CODE
 
/** Stores the value as an error code and checks if an error occurred.
 *  @param value The value to be checked. May be a function call. Input parameter.
 *  @returns FALSE if the value indicates success (EOK).
 *  @returns TRUE otherwise.
 */
#define ERROR_OCCURRED( value )     (( ERROR_CODE = ( value )) != EOK )
 
/** Checks if an error occurred and immediately exits the actual function returning the error code.
 *  @param value The value to be checked. May be a function call. Input parameter.
 */
#define ERROR_PROPAGATE( value )    if( ERROR_OCCURRED( value )) return ERROR_CODE
 
#endif
 
/** @}
 */
 

Subversion Repositories HelenOS

(root)/branches/network/uspace/srv/net/err.h @ 3846 – Rev 3846 → 3912

Rev 3846		Rev 3912
1	/*	1	/*
2	* Copyright (c) 2008 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	29	/** @addtogroup net
30	* @{	30	* @{
31	*/	31	*/
32		32
33	/** @file	33	/** @file
34	* Common error processing codes and routines.	34	* Common error processing codes and routines.
35	*/	35	*/
36		36
37	#ifndef __NET_ERR_H__	37	#ifndef __NET_ERR_H__
38	#define __NET_ERR_H__	38	#define __NET_ERR_H__
39		39
40	#include <errno.h>	40	#include <errno.h>
41		41
42	/** An actual stored error code.	42	/** An actual stored error code.
43	*/	43	*/
44	#define ERROR_CODE error_check_return_value	44	#define ERROR_CODE error_check_return_value
45		45
46	/** An error processing routines declaration.	46	/** An error processing routines declaration.
47	* This has to be declared in the block where the error processing is desired.	47	* This has to be declared in the block where the error processing is desired.
48	*/	48	*/
49	#define ERROR_DECLARE int ERROR_CODE	49	#define ERROR_DECLARE int ERROR_CODE
50		50
51	/** Stores the value as an error code and checks if an error occured.	51	/** Stores the value as an error code and checks if an error occurred.
52	* @param value The value to be checked. May be a function call. Input parameter.	52	* @param value The value to be checked. May be a function call. Input parameter.
53	* @returns FALSE if the value indicates success (EOK).	53	* @returns FALSE if the value indicates success (EOK).
54	* @returns TRUE otherwise.	54	* @returns TRUE otherwise.
55	*/	55	*/
56	#define ERROR_OCCURED( value ) (( ERROR_CODE = ( value )) != EOK )	56	#define ERROR_OCCURRED( value ) (( ERROR_CODE = ( value )) != EOK )
57		57
58	/** Checks if an error occured and immediatelly exits the actual function returning the error code.	58	/** Checks if an error occurred and immediately exits the actual function returning the error code.
59	* @param value The value to be checked. May be a function call. Input parameter.	59	* @param value The value to be checked. May be a function call. Input parameter.
60	*/	60	*/
61	#define ERROR_PROPAGATE( value ) if( ERROR_OCCURED( value )) return ERROR_CODE	61	#define ERROR_PROPAGATE( value ) if( ERROR_OCCURRED( value )) return ERROR_CODE
62		62
63	#endif	63	#endif
64		64
65	/** @}	65	/** @}
66	*/	66	*/
67		67