source: mainline/uspace/lib/c/include/ipc/logger.h@ 31e9fe0

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 31e9fe0 was bf9ac4e8, checked in by Vojtech Horky <vojtechhorky@…>, 13 years ago

Add comments to logger IPC

  • Property mode set to 100644
File size: 2.6 KB
Line 
1/*
2 * Copyright (c) 2012 Vojtech Horky
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
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
15 * derived from this software without specific prior written permission.
16 *
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
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
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
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
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/** @addtogroup libc
30 * @{
31 */
32
33#ifndef LIBC_IPC_LOGGER_H_
34#define LIBC_IPC_LOGGER_H_
35
36#include <ipc/common.h>
37
38typedef enum {
39 /** Set (global) default displayed logging level.
40 *
41 * Arguments: new log level.
42 * Returns: error code
43 */
44 LOGGER_CONTROL_SET_DEFAULT_LEVEL = IPC_FIRST_USER_METHOD,
45 /** Set displayed level for given log.
46 *
47 * Arguments: new log level.
48 * Returns: error code
49 * Followed by: string with full log name.
50 */
51 LOGGER_CONTROL_SET_LOG_LEVEL
52} logger_control_request_t;
53
54typedef enum {
55 /** Create new log.
56 *
57 * Arguments: parent log id (0 for top-level log).
58 * Returns: error code, log id
59 * Followed by: string with log name.
60 */
61 LOGGER_WRITER_CREATE_LOG = IPC_FIRST_USER_METHOD,
62 /** Write a message to a given log.
63 *
64 * Arguments: log id, message severity level (log_level_t)
65 * Returns: error code
66 * Followed by: string with the message.
67 */
68 LOGGER_WRITER_MESSAGE
69} logger_writer_request_t;
70
71typedef enum {
72 /** Interface for controlling logger behavior. */
73 LOGGER_INTERFACE_CONTROL,
74 /** Interface for servers writing to the log. */
75 LOGGER_INTERFACE_WRITER
76} logger_interface_t;
77
78#endif
79
80/** @}
81 */
Note: See TracBrowser for help on using the repository browser.