diff options
Diffstat (limited to 'build/doc/html/classpw__log.html')
| -rw-r--r-- | build/doc/html/classpw__log.html | 341 |
1 files changed, 341 insertions, 0 deletions
diff --git a/build/doc/html/classpw__log.html b/build/doc/html/classpw__log.html new file mode 100644 index 00000000..5a2bd584 --- /dev/null +++ b/build/doc/html/classpw__log.html @@ -0,0 +1,341 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.15"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>PipeWire: pw_log Class Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ + $(document).ready(initResizable); +/* @license-end */</script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">PipeWire +  <span id="projectnumber">0.2.9</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.15 --> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(function() { + initMenu('',false,false,'search.php','Search'); +}); +/* @license-end */</script> +<div id="main-nav"></div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(document).ready(function(){initNavTree('classpw__log.html','');}); +/* @license-end */ +</script> +<div id="doc-content"> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> </div> + <div class="headertitle"> +<div class="title">pw_log Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>Logging functions of PipeWire. + <a href="classpw__log.html#details">More...</a></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:a66c4dbcfe71f20642b74e4ec1576ac2a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="classpw__log.html#a66c4dbcfe71f20642b74e4ec1576ac2a">pw_log_level_enabled</a>(lev)   (<a class="el" href="log_8c.html#ae98f1a3c52f402a7004bf30bc64f3ced">pw_log_level</a> >= (lev))</td></tr> +<tr class="memdesc:a66c4dbcfe71f20642b74e4ec1576ac2a"><td class="mdescLeft"> </td><td class="mdescRight">Check if a loglevel is enabled. <a href="#a66c4dbcfe71f20642b74e4ec1576ac2a">More...</a><br /></td></tr> +<tr class="separator:a66c4dbcfe71f20642b74e4ec1576ac2a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a54b35b39e7e93a9004fa8364fcbd04d0"><td class="memItemLeft" align="right" valign="top">SPA_EXPORT void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpw__log.html#a54b35b39e7e93a9004fa8364fcbd04d0">pw_log_set</a> (struct spa_log *log)</td></tr> +<tr class="memdesc:a54b35b39e7e93a9004fa8364fcbd04d0"><td class="mdescLeft"> </td><td class="mdescRight">Set the global log interface. <a href="#a54b35b39e7e93a9004fa8364fcbd04d0">More...</a><br /></td></tr> +<tr class="separator:a54b35b39e7e93a9004fa8364fcbd04d0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abf444d2c0e01bebd58dcc2f31661843f"><td class="memItemLeft" align="right" valign="top">SPA_EXPORT struct spa_log * </td><td class="memItemRight" valign="bottom"><a class="el" href="classpw__log.html#abf444d2c0e01bebd58dcc2f31661843f">pw_log_get</a> (void)</td></tr> +<tr class="memdesc:abf444d2c0e01bebd58dcc2f31661843f"><td class="mdescLeft"> </td><td class="mdescRight">Get the global log interface. <a href="#abf444d2c0e01bebd58dcc2f31661843f">More...</a><br /></td></tr> +<tr class="separator:abf444d2c0e01bebd58dcc2f31661843f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa88314a3008bc42ef30cb53f9c8247a6"><td class="memItemLeft" align="right" valign="top">SPA_EXPORT void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpw__log.html#aa88314a3008bc42ef30cb53f9c8247a6">pw_log_set_level</a> (enum spa_log_level level)</td></tr> +<tr class="memdesc:aa88314a3008bc42ef30cb53f9c8247a6"><td class="mdescLeft"> </td><td class="mdescRight">Set the global log level. <a href="#aa88314a3008bc42ef30cb53f9c8247a6">More...</a><br /></td></tr> +<tr class="separator:aa88314a3008bc42ef30cb53f9c8247a6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0f5b3dbbf5ed3b45c122b7c58fbb3b55"><td class="memItemLeft" align="right" valign="top">SPA_EXPORT void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpw__log.html#a0f5b3dbbf5ed3b45c122b7c58fbb3b55">pw_log_log</a> (enum spa_log_level level, const char *file, int line, const char *func, const char *fmt,...)</td></tr> +<tr class="memdesc:a0f5b3dbbf5ed3b45c122b7c58fbb3b55"><td class="mdescLeft"> </td><td class="mdescRight">Log a message. <a href="#a0f5b3dbbf5ed3b45c122b7c58fbb3b55">More...</a><br /></td></tr> +<tr class="separator:a0f5b3dbbf5ed3b45c122b7c58fbb3b55"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9f2538cda2c857edf75105b33d07f7e0"><td class="memItemLeft" align="right" valign="top">SPA_EXPORT void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpw__log.html#a9f2538cda2c857edf75105b33d07f7e0">pw_log_logv</a> (enum spa_log_level level, const char *file, int line, const char *func, const char *fmt, va_list args)</td></tr> +<tr class="memdesc:a9f2538cda2c857edf75105b33d07f7e0"><td class="mdescLeft"> </td><td class="mdescRight">Log a message with va_list. <a href="#a9f2538cda2c857edf75105b33d07f7e0">More...</a><br /></td></tr> +<tr class="separator:a9f2538cda2c857edf75105b33d07f7e0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a995a5e0ef414e9246fbf2ad56b0ce281"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="classpw__log.html#a995a5e0ef414e9246fbf2ad56b0ce281">pw_log_error</a>(...)   <a class="el" href="classpw__log.html">pw_log</a>(SPA_LOG_LEVEL_ERROR,__VA_ARGS__)</td></tr> +<tr class="memdesc:a995a5e0ef414e9246fbf2ad56b0ce281"><td class="mdescLeft"> </td><td class="mdescRight">Log an error message. <a href="#a995a5e0ef414e9246fbf2ad56b0ce281">More...</a><br /></td></tr> +<tr class="separator:a995a5e0ef414e9246fbf2ad56b0ce281"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2d2c2dc7d35b7104f5caef08df416767"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="classpw__log.html#a2d2c2dc7d35b7104f5caef08df416767">pw_log_warn</a>(...)   <a class="el" href="classpw__log.html">pw_log</a>(SPA_LOG_LEVEL_WARN,__VA_ARGS__)</td></tr> +<tr class="memdesc:a2d2c2dc7d35b7104f5caef08df416767"><td class="mdescLeft"> </td><td class="mdescRight">Log a warning message. <a href="#a2d2c2dc7d35b7104f5caef08df416767">More...</a><br /></td></tr> +<tr class="separator:a2d2c2dc7d35b7104f5caef08df416767"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aaa7a8d5ecdd95e45af3d48d798a3d4af"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="classpw__log.html#aaa7a8d5ecdd95e45af3d48d798a3d4af">pw_log_info</a>(...)   <a class="el" href="classpw__log.html">pw_log</a>(SPA_LOG_LEVEL_INFO,__VA_ARGS__)</td></tr> +<tr class="memdesc:aaa7a8d5ecdd95e45af3d48d798a3d4af"><td class="mdescLeft"> </td><td class="mdescRight">Log an info message. <a href="#aaa7a8d5ecdd95e45af3d48d798a3d4af">More...</a><br /></td></tr> +<tr class="separator:aaa7a8d5ecdd95e45af3d48d798a3d4af"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a98a49c37f11de525890014e927e34d02"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="classpw__log.html#a98a49c37f11de525890014e927e34d02">pw_log_debug</a>(...)   <a class="el" href="classpw__log.html">pw_log</a>(SPA_LOG_LEVEL_DEBUG,__VA_ARGS__)</td></tr> +<tr class="memdesc:a98a49c37f11de525890014e927e34d02"><td class="mdescLeft"> </td><td class="mdescRight">Log a debug message. <a href="#a98a49c37f11de525890014e927e34d02">More...</a><br /></td></tr> +<tr class="separator:a98a49c37f11de525890014e927e34d02"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0a957072ba799bbf2bdc77501ccd81d0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="classpw__log.html#a0a957072ba799bbf2bdc77501ccd81d0">pw_log_trace</a>(...)   <a class="el" href="classpw__log.html">pw_log</a>(SPA_LOG_LEVEL_TRACE,__VA_ARGS__)</td></tr> +<tr class="memdesc:a0a957072ba799bbf2bdc77501ccd81d0"><td class="mdescLeft"> </td><td class="mdescRight">Log a trace message. <a href="#a0a957072ba799bbf2bdc77501ccd81d0">More...</a><br /></td></tr> +<tr class="separator:a0a957072ba799bbf2bdc77501ccd81d0"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Logging functions of PipeWire. </p> +<p>Logging is performed to stdout and stderr. Trace logging is performed in a lockfree ringbuffer and written out from the main thread as to not block the realtime threads. </p> +</div><h2 class="groupheader">Member Function Documentation</h2> +<a id="abf444d2c0e01bebd58dcc2f31661843f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#abf444d2c0e01bebd58dcc2f31661843f">◆ </a></span>pw_log_get()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">SPA_EXPORT struct spa_log * pw_log_get </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get the global log interface. </p> +<dl class="section return"><dt>Returns</dt><dd>the global log </dd></dl> + +</div> +</div> +<a id="a0f5b3dbbf5ed3b45c122b7c58fbb3b55"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a0f5b3dbbf5ed3b45c122b7c58fbb3b55">◆ </a></span>pw_log_log()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">SPA_EXPORT void pw_log_log </td> + <td>(</td> + <td class="paramtype">enum spa_log_level </td> + <td class="paramname"><em>level</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>file</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>line</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>func</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>fmt</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>...</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Log a message. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">level</td><td>the log level </td></tr> + <tr><td class="paramname">file</td><td>the file this message originated from </td></tr> + <tr><td class="paramname">line</td><td>the line number </td></tr> + <tr><td class="paramname">func</td><td>the function </td></tr> + <tr><td class="paramname">fmt</td><td>the printf style format </td></tr> + <tr><td class="paramname">...</td><td>printf style arguments to log </td></tr> + </table> + </dd> +</dl> + +<p class="reference">References <a class="el" href="classpw__log.html#a66c4dbcfe71f20642b74e4ec1576ac2a">pw_log_level_enabled</a>.</p> + +</div> +</div> +<a id="a9f2538cda2c857edf75105b33d07f7e0"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a9f2538cda2c857edf75105b33d07f7e0">◆ </a></span>pw_log_logv()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">SPA_EXPORT void pw_log_logv </td> + <td>(</td> + <td class="paramtype">enum spa_log_level </td> + <td class="paramname"><em>level</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>file</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>line</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>func</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>fmt</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">va_list </td> + <td class="paramname"><em>args</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Log a message with va_list. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">level</td><td>the log level </td></tr> + <tr><td class="paramname">file</td><td>the file this message originated from </td></tr> + <tr><td class="paramname">line</td><td>the line number </td></tr> + <tr><td class="paramname">func</td><td>the function </td></tr> + <tr><td class="paramname">fmt</td><td>the printf style format </td></tr> + <tr><td class="paramname">args</td><td>a va_list of arguments </td></tr> + </table> + </dd> +</dl> + +<p class="reference">References <a class="el" href="classpw__log.html#a66c4dbcfe71f20642b74e4ec1576ac2a">pw_log_level_enabled</a>.</p> + +</div> +</div> +<a id="a54b35b39e7e93a9004fa8364fcbd04d0"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a54b35b39e7e93a9004fa8364fcbd04d0">◆ </a></span>pw_log_set()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">SPA_EXPORT void pw_log_set </td> + <td>(</td> + <td class="paramtype">struct spa_log * </td> + <td class="paramname"><em>log</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Set the global log interface. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">log</td><td>the global log to set </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="aa88314a3008bc42ef30cb53f9c8247a6"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aa88314a3008bc42ef30cb53f9c8247a6">◆ </a></span>pw_log_set_level()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">SPA_EXPORT void pw_log_set_level </td> + <td>(</td> + <td class="paramtype">enum spa_log_level </td> + <td class="paramname"><em>level</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Set the global log level. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">level</td><td>the new log level </td></tr> + </table> + </dd> +</dl> + +<p class="reference">References <a class="el" href="log_8c.html#ae98f1a3c52f402a7004bf30bc64f3ced">pw_log_level</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="log_8h_source.html">log.h</a></li> +<li><a class="el" href="log_8c.html">log.c</a></li> +</ul> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><a class="el" href="classpw__log.html">pw_log</a></li> + <li class="footer">Generated by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li> + </ul> +</div> +</body> +</html> |