1 /* 2 * Copyright © 2015 Samsung Electronics Co., Ltd 3 * 4 * Permission is hereby granted, free of charge, to any person obtaining 5 * a copy of this software and associated documentation files (the 6 * "Software"), to deal in the Software without restriction, including 7 * without limitation the rights to use, copy, modify, merge, publish, 8 * distribute, sublicense, and/or sell copies of the Software, and to 9 * permit persons to whom the Software is furnished to do so, subject to 10 * the following conditions: 11 * 12 * The above copyright notice and this permission notice (including the 13 * next paragraph) shall be included in all copies or substantial 14 * portions of the Software. 15 * 16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 17 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 19 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS 20 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN 21 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 22 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 23 * SOFTWARE. 24 */ 25 26 #ifndef ZUC_COLLECTOR_H 27 #define ZUC_COLLECTOR_H 28 29 struct zuc_event_listener; 30 struct zuc_test; 31 32 /** 33 * Creates a new instance of an event collector that will attach events 34 * to the current test directly or via connection from child to parent. 35 * 36 * @param pipe_fd pointer to the file descriptor to use for communication if 37 * needed. If the value is -1 the events will be attached directly to the 38 * current test. Otherwise events will be passed back via IPC over this 39 * pipe with the expectation that the payload will be handled in the parent 40 * process via zuc_process_message(). 41 * @return a new collector instance. 42 * @see zuc_process_message() 43 */ 44 struct zuc_event_listener * 45 zuc_collector_create(int *pipe_fd); 46 47 /** 48 * Reads events from the given pipe and processes them. 49 * 50 * @param test the currently active test to attach events for. 51 * @param pipe_fd the file descriptor of the pipe to read from. 52 * @return a positive value if a message was received, 0 if the end has 53 * been reached and -1 if an error has occurred. 54 */ 55 int 56 zuc_process_message(struct zuc_test *test, int pipe_fd); 57 58 #endif /* ZUC_COLLECTOR_H */ 59