[babeltrace.git] / include / babeltrace / graph / component-status.h

#ifndef BABELTRACE_GRAPH_COMPONENT_STATUS_H
#define BABELTRACE_GRAPH_COMPONENT_STATUS_H

/*
 * BabelTrace - Babeltrace Component Interface
 *
 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#ifdef __cplusplus
extern "C" {
#endif

/**
 * Status code. Errors are always negative.
 */
enum bt_component_status {
	/** No error, okay. */
	BT_COMPONENT_STATUS_OK				= 0,
	/** No more work to be done by this component. **/
	BT_COMPONENT_STATUS_END				= 1,
	/**
	 * Component can't process a notification at this time
	 * (e.g. would block), try again later.
	 */
	BT_COMPONENT_STATUS_AGAIN			= 11,
	/** Refuse port connection. */
	BT_COMPONENT_STATUS_REFUSE_PORT_CONNECTION	= 111,
	/** General error. */
	BT_COMPONENT_STATUS_ERROR			= -1,
	/** Unsupported component feature. */
	BT_COMPONENT_STATUS_UNSUPPORTED			= -2,
	/** Invalid arguments. */
	BT_COMPONENT_STATUS_INVALID			= -22,
	/** Memory allocation failure. */
	BT_COMPONENT_STATUS_NOMEM			= -12,
	/** Element not found. */
	BT_COMPONENT_STATUS_NOT_FOUND			= -19,
	BT_COMPONENT_STATUS_GRAPH_IS_CANCELED		= 125,
};

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE_GRAPH_COMPONENT_STATUS_H */
Commit	Line	Data
1ca80abd PP	1	#ifndef BABELTRACE_GRAPH_COMPONENT_STATUS_H
1ca80abd PP	2	#define BABELTRACE_GRAPH_COMPONENT_STATUS_H
cc469c42 PP	3
	4	/*
	5	* BabelTrace - Babeltrace Component Interface
	6	*
	7	* Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
	8	*
	9	* Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
	10	*
	11	* Permission is hereby granted, free of charge, to any person obtaining a copy
	12	* of this software and associated documentation files (the "Software"), to deal
	13	* in the Software without restriction, including without limitation the rights
	14	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	15	* copies of the Software, and to permit persons to whom the Software is
	16	* furnished to do so, subject to the following conditions:
	17	*
	18	* The above copyright notice and this permission notice shall be included in
	19	* all copies or substantial portions of the Software.
	20	*
	21	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	22	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	23	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	24	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	25	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	26	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	27	* SOFTWARE.
	28	*/
	29
	30	#ifdef __cplusplus
	31	extern "C" {
	32	#endif
	33
	34	/**
	35	* Status code. Errors are always negative.
	36	*/
	37	enum bt_component_status {
	38	/** No error, okay. */
	39	BT_COMPONENT_STATUS_OK = 0,
	40	/ No more work to be done by this component. /
	41	BT_COMPONENT_STATUS_END = 1,
	42	/**
	43	* Component can't process a notification at this time
	44	* (e.g. would block), try again later.
	45	*/
fe8ad2b6	46	BT_COMPONENT_STATUS_AGAIN = 11,
cc469c42	47	/** Refuse port connection. */
fe8ad2b6	48	BT_COMPONENT_STATUS_REFUSE_PORT_CONNECTION = 111,
cc469c42 PP	49	/** General error. */
	50	BT_COMPONENT_STATUS_ERROR = -1,
	51	/** Unsupported component feature. */
	52	BT_COMPONENT_STATUS_UNSUPPORTED = -2,
	53	/** Invalid arguments. */
fe8ad2b6	54	BT_COMPONENT_STATUS_INVALID = -22,
cc469c42	55	/** Memory allocation failure. */
fe8ad2b6	56	BT_COMPONENT_STATUS_NOMEM = -12,
cc469c42	57	/** Element not found. */
fe8ad2b6	58	BT_COMPONENT_STATUS_NOT_FOUND = -19,
bd7cc15b	59	BT_COMPONENT_STATUS_GRAPH_IS_CANCELED = 125,
cc469c42 PP	60	};
	61
	62	#ifdef __cplusplus
	63	}
	64	#endif
	65
1ca80abd	66	#endif /* BABELTRACE_GRAPH_COMPONENT_STATUS_H */