/usr/share/doc/libalog0.4.1-base-dev/api/alog-facilities.ads.html is in libalog0.4.1-base-dev 0.4.1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 | <?xml version='1.0' encoding='utf-8'?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html><head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta http-equiv="Content-Script-Type" content="text/javascript"/>
<title>
Package: Facilities
</title>
<link rel='stylesheet' href='support/docgen.css' type='text/css'/>
<link rel='stylesheet' href='support/tags.css' type='text/css'/>
<script src='support/docgen.js' type='text/javascript' charset='utf-8'></script>
</head>
<body onload="onloadDoc();">
<div id='leftSide'>
<div id='leftSideInside'>
<div id='header'>
<h2 class="button">Documentation</h2>
<a href='toc.html'><div class="button2">Table of Contents</div></a>
<a href='tree.html'><div class="button2">Class Inheritance Tree</div></a>
</div>
<div id='navigation'>
<h2 class="button">Navigation</h2>
<a href='#Description'><div class="button2">Description</div></a>
<a href='#Packages'><div class="button2">Packages</div></a>
<a href='#Classes'><div class="button2">Classes</div></a>
<a href='#Types'><div class="button2">Types</div></a>
<a href='#Methods'><div class="button2">Subprograms & Entries</div></a>
</div><!-- navigation -->
</div>
</div> <!-- leftSide -->
<div class='default' id='rightSide'>
<div id='rightSideInside'>
<div id='Index'>
<h2>Index</h2>
<script type="text/javascript">
var names = new Array (
new Array ('BS_<wbr/>Path', 'alog-facilities.ads:119:12', 'package-spec'),
new Array ('Instance (abstract)', 'alog-facilities.ads:37:9', 'class-spec'),
new Array ('Class', 'alog-facilities.ads:41:12', 'type-spec'),
new Array ('Handle', 'alog-facilities.ads:43:9', 'type-spec'),
new Array ('=', 'alog-facilities.ads:45:13', 'subp-spec'),
new Array ('Set_<wbr/>Name', 'alog-facilities.ads:50:14', 'subp-spec'),
new Array ('Get_<wbr/>Name', 'alog-facilities.ads:55:13', 'subp-spec'),
new Array ('Get_<wbr/>Timestamp', 'alog-facilities.ads:58:13', 'subp-spec'),
new Array ('Process', 'alog-facilities.ads:65:14', 'subp-spec'),
new Array ('Write (abstract)', 'alog-facilities.ads:70:14', 'subp-spec'),
new Array ('Toggle_<wbr/>Write_<wbr/>Timestamp', 'alog-facilities.ads:77:14', 'subp-spec'),
new Array ('Toggle_<wbr/>UTC_<wbr/>Timestamp', 'alog-facilities.ads:82:14', 'subp-spec'),
new Array ('Is_<wbr/>Write_<wbr/>Timestamp', 'alog-facilities.ads:87:13', 'subp-spec'),
new Array ('Is_<wbr/>UTC_<wbr/>Timestamp', 'alog-facilities.ads:90:13', 'subp-spec'),
new Array ('Toggle_<wbr/>Write_<wbr/>Loglevel', 'alog-facilities.ads:93:14', 'subp-spec'),
new Array ('Is_<wbr/>Write_<wbr/>Loglevel', 'alog-facilities.ads:98:13', 'subp-spec'),
new Array ('Toggle_<wbr/>Write_<wbr/>Source', 'alog-facilities.ads:101:14', 'subp-spec'),
new Array ('Is_<wbr/>Write_<wbr/>Source', 'alog-facilities.ads:106:13', 'subp-spec'),
new Array ('Setup', 'alog-facilities.ads:109:14', 'subp-spec'),
new Array ('Teardown', 'alog-facilities.ads:114:14', 'subp-spec'),
new Array ('dummy', '', ''));
printIndexList (names);
</script>
<noscript>
<ul>
<li class='package-spec'><a href="#alog-facilities.ads:119:12">BS_<wbr/>Path</a></li>
<li class='class-spec'><a href="#alog-facilities.ads:37:9">Instance (abstract)</a></li>
<li class='type-spec'><a href="#alog-facilities.ads:41:12">Class</a></li>
<li class='type-spec'><a href="#alog-facilities.ads:43:9">Handle</a></li>
<li class='subp-spec'><a href="#alog-facilities.ads:45:13">=</a></li>
<li class='subp-spec'><a href="#alog-facilities.ads:50:14">Set_<wbr/>Name</a></li>
<li class='subp-spec'><a href="#alog-facilities.ads:55:13">Get_<wbr/>Name</a></li>
<li class='subp-spec'><a href="#alog-facilities.ads:58:13">Get_<wbr/>Timestamp</a></li>
<li class='subp-spec'><a href="#alog-facilities.ads:65:14">Process</a></li>
<li class='subp-spec'><a href="#alog-facilities.ads:70:14">Write (abstract)</a></li>
<li class='subp-spec'><a href="#alog-facilities.ads:77:14">Toggle_<wbr/>Write_<wbr/>Timestamp</a></li>
<li class='subp-spec'><a href="#alog-facilities.ads:82:14">Toggle_<wbr/>UTC_<wbr/>Timestamp</a></li>
<li class='subp-spec'><a href="#alog-facilities.ads:87:13">Is_<wbr/>Write_<wbr/>Timestamp</a></li>
<li class='subp-spec'><a href="#alog-facilities.ads:90:13">Is_<wbr/>UTC_<wbr/>Timestamp</a></li>
<li class='subp-spec'><a href="#alog-facilities.ads:93:14">Toggle_<wbr/>Write_<wbr/>Loglevel</a></li>
<li class='subp-spec'><a href="#alog-facilities.ads:98:13">Is_<wbr/>Write_<wbr/>Loglevel</a></li>
<li class='subp-spec'><a href="#alog-facilities.ads:101:14">Toggle_<wbr/>Write_<wbr/>Source</a></li>
<li class='subp-spec'><a href="#alog-facilities.ads:106:13">Is_<wbr/>Write_<wbr/>Source</a></li>
<li class='subp-spec'><a href="#alog-facilities.ads:109:14">Setup</a></li>
<li class='subp-spec'><a href="#alog-facilities.ads:114:14">Teardown</a></li>
</ul>
</noscript>
</div>
</div>
</div>
<div class='default' id='documentation'>
<div class='title'>
Package:
<span class="droplink"><i>Facilities</i><ul>
<li><a href="src_alog-facilities.ads.html">Goto spec source</a></li>
</ul></span>
</div>
<div class='subprograms'>
<h1><a name='Description' id='Description'></a>Description</h1>
<div class="class">
<div class='details'><pre><span class="keyword">package</span> <span class="name_emphasis">Alog.Facilities</span> <span class="keyword">is</span></pre></div>
<div class='comment'><a href="alog.ads.html#alog.ads:27:9" title="Alog">Alog</a> facilities package. Provides common data and methods used by all
facilities.
</div>
</div>
</div>
<div class='subprograms'>
<h1><a name='Packages' id='Packages'></a>Packages</h1>
<div class="class">
<h3>
<a name='alog-facilities.ads:119:12' id='alog-facilities.ads:119:12'></a>
BS_Path
<span class='type'>(new Generic_Bounded_Length)</span>
</h3>
<div class='details'><pre><span class="keyword">package</span> <span class="name_emphasis">BS_Path</span> <span class="keyword">is</span> <span class="keyword">new</span> Generic_Bounded_Length (<a href="alog.ads.html#alog.ads:43:4" title="defined at alog.ads:43:4">Max_Path_Length</a>);</pre></div>
</div>
</div>
<div class='subprograms'>
<h1><a name='Classes' id='Classes'></a>Classes</h1>
<div class="class">
<h3><a name='alog-facilities.ads:37:9' id='alog-facilities.ads:37:9'></a>
<span class="droplink">Instance (abstract)<ul>
<li><a href="src_alog-facilities.ads.html#l37">Goto declaration in source</a></li>
<li><a href="src_alog-facilities.ads.html#l126">Goto full declaration in source</a></li>
</ul></span>
</h3>
<div class='details'><pre><span class="keyword">type</span> <span class="name_emphasis">Instance</span> <span class="keyword">is</span> <span class="keyword">abstract</span> <span class="keyword">tagged</span> <span class="keyword">limited</span> <span class="keyword">private</span>;</pre></div>
<div class='profile'>
<div>
<h4>Immediate Children:</h4>
<div><a href="alog-facilities.ads.html#alog-facilities.ads:41:12" title="defined at alog-facilities.ads:41:12">Alog.Facilities.Class</a></div>
<div><a href="alog-facilities-file_descriptor.ads.html#alog-facilities-file_descriptor.ads:29:9" title="defined at alog-facilities-file_descriptor.ads:29:9">Alog.Facilities.File_Descriptor.Instance</a></div>
<div><a href="alog-facilities-pgsql.ads.html#alog-facilities-pgsql.ads:28:9" title="defined at alog-facilities-pgsql.ads:28:9">Alog.Facilities.Pgsql.Instance</a></div>
<div><a href="alog-facilities-smtp.ads.html#alog-facilities-smtp.ads:32:9" title="defined at alog-facilities-smtp.ads:32:9">Alog.Facilities.SMTP.Instance</a></div>
<div><a href="alog-facilities-syslog.ads.html#alog-facilities-syslog.ads:25:9" title="defined at alog-facilities-syslog.ads:25:9">Alog.Facilities.Syslog.Instance</a></div>
<div><a href="alog-facilities-xmpp.ads.html#alog-facilities-xmpp.ads:27:9" title="defined at alog-facilities-xmpp.ads:27:9">Alog.Facilities.XMPP.Instance</a></div>
</div>
<div>
<h4>Primitive operations:</h4>
<div><span class="droplink">Setup<ul><li><a href="alog-facilities.ads.html#alog-facilities.ads:109:14" title="To API doc">To API doc</a></li><li><a href="src_alog-facilities.ads.html#l109" title="To spec">To spec</a></li></ul></span></div>
<div><span class="droplink">Teardown<ul><li><a href="alog-facilities.ads.html#alog-facilities.ads:114:14" title="To API doc">To API doc</a></li><li><a href="src_alog-facilities.ads.html#l114" title="To spec">To spec</a></li></ul></span></div>
<div><span class="droplink">Write<ul><li><a href="alog-facilities.ads.html#alog-facilities.ads:70:14" title="To API doc">To API doc</a></li><li><a href="src_alog-facilities.ads.html#l70" title="To spec">To spec</a></li></ul></span></div>
</div>
</div>
<div class='comment'>Abstract type facility instance. All facilities in the <a href="alog.ads.html#alog.ads:27:9" title="Alog">Alog</a> framework
must implement this type.
</div>
</div>
</div>
<div class='subprograms'>
<h1><a name='Types' id='Types'></a>Types</h1>
<div class="class">
<h3>
<a name='alog-facilities.ads:41:12' id='alog-facilities.ads:41:12'></a>
<span class="droplink">Class<ul>
<li><a href="src_alog-facilities.ads.html#l41">Goto declaration in source</a></li>
</ul></span>
</h3>
<div class='details'><pre><span class="keyword">subtype</span> <span class="name_emphasis">Class</span> <span class="keyword">is</span> <a href="alog-facilities.ads.html#alog-facilities.ads:37:9" title="defined at alog-facilities.ads:37:9">Instance</a>'<a href="alog-facilities.ads.html#alog-facilities.ads:41:12" title="defined at alog-facilities.ads:41:12">Class</a>;</pre></div>
</div>
<div class="class">
<h3>
<a name='alog-facilities.ads:43:9' id='alog-facilities.ads:43:9'></a>
<span class="droplink">Handle<ul>
<li><a href="src_alog-facilities.ads.html#l43">Goto declaration in source</a></li>
</ul></span>
</h3>
<div class='details'><pre><span class="keyword">type</span> <span class="name_emphasis">Handle</span> <span class="keyword">is</span> <span class="keyword">access</span> <span class="keyword">all</span> <a href="alog-facilities.ads.html#alog-facilities.ads:41:12" title="defined at alog-facilities.ads:41:12">Class</a>;</pre></div>
</div>
</div>
<div class='subprograms'>
<h1><a name='Methods' id='Methods'></a>Subprograms & Entries</h1>
<div class="class">
<h3>
<a name='alog-facilities.ads:45:13' id='alog-facilities.ads:45:13'></a>
<span class="droplink">=<ul>
<li><a href="src_alog-facilities.ads.html#l45">Goto spec in source</a></li>
</ul></span>
</h3>
<div class='details'><pre><span class="keyword">function</span> <span class="name_emphasis">"="</span> <table><tr><td>(</td><td><span class="name"><a name="alog-facilities.ads:46:7"></a>Left</span></td><td>: <a href="alog-facilities.ads.html#alog-facilities.ads:43:9" title="defined at alog-facilities.ads:43:9">Handle</a>;</td></tr><tr><td></td><td><span class="name"><a name="alog-facilities.ads:47:7"></a>Right</span></td><td>: <a href="alog-facilities.ads.html#alog-facilities.ads:43:9" title="defined at alog-facilities.ads:43:9">Handle</a>) <span class="keyword">return</span> Boolean;</td></tr></table></pre></div>
<div class='comment'>Equal function.
</div>
</div>
<div class="class">
<h3>
<a name='alog-facilities.ads:50:14' id='alog-facilities.ads:50:14'></a>
<span class="droplink">Set_Name<ul>
<li><a href="src_alog-facilities.ads.html#l50">Goto spec in source</a></li>
</ul></span>
</h3>
<div class='details'><pre><span class="keyword">procedure</span> <span class="name_emphasis">Set_Name</span> <table><tr><td>(</td><td><span class="name"><a name="alog-facilities.ads:51:7"></a>Facility</span></td><td>: <span class="keyword">in</span> <span class="keyword">out</span> <a href="alog-facilities.ads.html#alog-facilities.ads:41:12" title="defined at alog-facilities.ads:41:12">Class</a>;</td></tr><tr><td></td><td><span class="name"><a name="alog-facilities.ads:52:7"></a>Name</span></td><td>: String);</td></tr></table></pre></div>
<div class='comment'>Set facility name.
</div>
</div>
<div class="class">
<h3>
<a name='alog-facilities.ads:55:13' id='alog-facilities.ads:55:13'></a>
<span class="droplink">Get_Name<ul>
<li><a href="src_alog-facilities.ads.html#l55">Goto spec in source</a></li>
</ul></span>
</h3>
<div class='details'><pre><span class="keyword">function</span> <span class="name_emphasis">Get_Name</span> <table><tr><td>(</td><td><span class="name"><a name="alog-facilities.ads:55:23"></a>Facility</span></td><td>: <a href="alog-facilities.ads.html#alog-facilities.ads:41:12" title="defined at alog-facilities.ads:41:12">Class</a>) <span class="keyword">return</span> String;</td></tr></table></pre></div>
<div class='comment'>Get facility name.
</div>
</div>
<div class="class">
<h3>
<a name='alog-facilities.ads:58:13' id='alog-facilities.ads:58:13'></a>
<span class="droplink">Get_Timestamp<ul>
<li><a href="src_alog-facilities.ads.html#l58">Goto spec in source</a></li>
</ul></span>
</h3>
<div class='details'><pre><span class="keyword">function</span> <span class="name_emphasis">Get_Timestamp</span> <table><tr><td>(</td><td><span class="name"><a name="alog-facilities.ads:59:7"></a>Facility</span></td><td>: <a href="alog-facilities.ads.html#alog-facilities.ads:41:12" title="defined at alog-facilities.ads:41:12">Class</a>;</td></tr><tr><td></td><td><span class="name"><a name="alog-facilities.ads:60:7"></a>Time</span></td><td>: Ada.Calendar.Time := Ada.Calendar.Clock) <span class="keyword">return</span> String;</td></tr></table></pre></div>
<div class='comment'>Creates a timestamp and returns it as String. If no Time is given, the
current time is used.
</div>
</div>
<div class="class">
<h3>
<a name='alog-facilities.ads:65:14' id='alog-facilities.ads:65:14'></a>
<span class="droplink">Process<ul>
<li><a href="src_alog-facilities.ads.html#l65">Goto spec in source</a></li>
</ul></span>
</h3>
<div class='details'><pre><span class="keyword">procedure</span> <span class="name_emphasis">Process</span> <table><tr><td>(</td><td><span class="name"><a name="alog-facilities.ads:66:7"></a>Facility</span></td><td>: <a href="alog-facilities.ads.html#alog-facilities.ads:41:12" title="defined at alog-facilities.ads:41:12">Class</a>;</td></tr><tr><td></td><td><span class="name"><a name="alog-facilities.ads:67:7"></a>Request</span></td><td>: <a href="alog-log_request.ads.html#alog-log_request.ads:32:9" title="defined at alog-log_request.ads:32:9">Log_Request.Instance</a>);</td></tr></table></pre></div>
<div class='comment'><a href="alog-facilities.ads.html#alog-facilities.ads:65:14" title="Process">Process</a> a log request.
</div>
</div>
<div class="class">
<h3>
<a name='alog-facilities.ads:70:14' id='alog-facilities.ads:70:14'></a>
<span class="droplink">Write (abstract)<ul>
<li><a href="src_alog-facilities.ads.html#l70">Goto spec in source</a></li>
</ul></span>
</h3>
<div class='details'><pre><span class="keyword">procedure</span> <span class="name_emphasis">Write</span> <table><tr><td>(</td><td><span class="name"><a name="alog-facilities.ads:71:7"></a>Facility</span></td><td>: <a href="alog-facilities.ads.html#alog-facilities.ads:37:9" title="defined at alog-facilities.ads:37:9">Instance</a>;</td></tr><tr><td></td><td><span class="name"><a name="alog-facilities.ads:72:7"></a>Level</span></td><td>: <a href="alog.ads.html#alog.ads:31:9" title="defined at alog.ads:31:9">Log_Level</a> := Info;</td></tr><tr><td></td><td><span class="name"><a name="alog-facilities.ads:73:7"></a>Msg</span></td><td>: String) <span class="keyword">is</span> <span class="keyword">abstract</span>;</td></tr></table></pre></div>
<div class='comment'><a href="alog-facilities.ads.html#alog-facilities.ads:70:14" title="Write">Write</a> message with specified log level. This procedure must be
implemented by all facilities.
</div>
</div>
<div class="class">
<h3>
<a name='alog-facilities.ads:77:14' id='alog-facilities.ads:77:14'></a>
<span class="droplink">Toggle_Write_Timestamp<ul>
<li><a href="src_alog-facilities.ads.html#l77">Goto spec in source</a></li>
</ul></span>
</h3>
<div class='details'><pre><span class="keyword">procedure</span> <span class="name_emphasis">Toggle_Write_Timestamp</span> <table><tr><td>(</td><td><span class="name"><a name="alog-facilities.ads:78:7"></a>Facility</span></td><td>: <span class="keyword">in</span> <span class="keyword">out</span> <a href="alog-facilities.ads.html#alog-facilities.ads:41:12" title="defined at alog-facilities.ads:41:12">Class</a>;</td></tr><tr><td></td><td><span class="name"><a name="alog-facilities.ads:79:7"></a>State</span></td><td>: Boolean);</td></tr></table></pre></div>
<div class='comment'>Enable/disable whether a timestamp is written for log messages.
</div>
</div>
<div class="class">
<h3>
<a name='alog-facilities.ads:82:14' id='alog-facilities.ads:82:14'></a>
<span class="droplink">Toggle_UTC_Timestamp<ul>
<li><a href="src_alog-facilities.ads.html#l82">Goto spec in source</a></li>
</ul></span>
</h3>
<div class='details'><pre><span class="keyword">procedure</span> <span class="name_emphasis">Toggle_UTC_Timestamp</span> <table><tr><td>(</td><td><span class="name"><a name="alog-facilities.ads:83:7"></a>Facility</span></td><td>: <span class="keyword">in</span> <span class="keyword">out</span> <a href="alog-facilities.ads.html#alog-facilities.ads:41:12" title="defined at alog-facilities.ads:41:12">Class</a>;</td></tr><tr><td></td><td><span class="name"><a name="alog-facilities.ads:84:7"></a>State</span></td><td>: Boolean);</td></tr></table></pre></div>
<div class='comment'>Enable/disable UTC timestamps for log messages.
</div>
</div>
<div class="class">
<h3>
<a name='alog-facilities.ads:87:13' id='alog-facilities.ads:87:13'></a>
<span class="droplink">Is_Write_Timestamp<ul>
<li><a href="src_alog-facilities.ads.html#l87">Goto spec in source</a></li>
</ul></span>
</h3>
<div class='details'><pre><span class="keyword">function</span> <span class="name_emphasis">Is_Write_Timestamp</span> <table><tr><td>(</td><td><span class="name"><a name="alog-facilities.ads:87:33"></a>Facility</span></td><td>: <a href="alog-facilities.ads.html#alog-facilities.ads:41:12" title="defined at alog-facilities.ads:41:12">Class</a>) <span class="keyword">return</span> Boolean;</td></tr></table></pre></div>
<div class='comment'>Returns the current value of Write_Timestamp.
</div>
</div>
<div class="class">
<h3>
<a name='alog-facilities.ads:90:13' id='alog-facilities.ads:90:13'></a>
<span class="droplink">Is_UTC_Timestamp<ul>
<li><a href="src_alog-facilities.ads.html#l90">Goto spec in source</a></li>
</ul></span>
</h3>
<div class='details'><pre><span class="keyword">function</span> <span class="name_emphasis">Is_UTC_Timestamp</span> <table><tr><td>(</td><td><span class="name"><a name="alog-facilities.ads:90:31"></a>Facility</span></td><td>: <a href="alog-facilities.ads.html#alog-facilities.ads:41:12" title="defined at alog-facilities.ads:41:12">Class</a>) <span class="keyword">return</span> Boolean;</td></tr></table></pre></div>
<div class='comment'>Returns True if the timestamp of the facility is written in UTC time.
</div>
</div>
<div class="class">
<h3>
<a name='alog-facilities.ads:93:14' id='alog-facilities.ads:93:14'></a>
<span class="droplink">Toggle_Write_Loglevel<ul>
<li><a href="src_alog-facilities.ads.html#l93">Goto spec in source</a></li>
</ul></span>
</h3>
<div class='details'><pre><span class="keyword">procedure</span> <span class="name_emphasis">Toggle_Write_Loglevel</span> <table><tr><td>(</td><td><span class="name"><a name="alog-facilities.ads:94:7"></a>Facility</span></td><td>: <span class="keyword">in</span> <span class="keyword">out</span> <a href="alog-facilities.ads.html#alog-facilities.ads:41:12" title="defined at alog-facilities.ads:41:12">Class</a>;</td></tr><tr><td></td><td><span class="name"><a name="alog-facilities.ads:95:7"></a>State</span></td><td>: Boolean);</td></tr></table></pre></div>
<div class='comment'>Enable/disable whether the loglevel is written for log messages.
</div>
</div>
<div class="class">
<h3>
<a name='alog-facilities.ads:98:13' id='alog-facilities.ads:98:13'></a>
<span class="droplink">Is_Write_Loglevel<ul>
<li><a href="src_alog-facilities.ads.html#l98">Goto spec in source</a></li>
</ul></span>
</h3>
<div class='details'><pre><span class="keyword">function</span> <span class="name_emphasis">Is_Write_Loglevel</span> <table><tr><td>(</td><td><span class="name"><a name="alog-facilities.ads:98:32"></a>Facility</span></td><td>: <a href="alog-facilities.ads.html#alog-facilities.ads:41:12" title="defined at alog-facilities.ads:41:12">Class</a>) <span class="keyword">return</span> Boolean;</td></tr></table></pre></div>
<div class='comment'>Returns the current value of Write_Loglevel.
</div>
</div>
<div class="class">
<h3>
<a name='alog-facilities.ads:101:14' id='alog-facilities.ads:101:14'></a>
<span class="droplink">Toggle_Write_Source<ul>
<li><a href="src_alog-facilities.ads.html#l101">Goto spec in source</a></li>
</ul></span>
</h3>
<div class='details'><pre><span class="keyword">procedure</span> <span class="name_emphasis">Toggle_Write_Source</span> <table><tr><td>(</td><td><span class="name"><a name="alog-facilities.ads:102:7"></a>Facility</span></td><td>: <span class="keyword">in</span> <span class="keyword">out</span> <a href="alog-facilities.ads.html#alog-facilities.ads:41:12" title="defined at alog-facilities.ads:41:12">Class</a>;</td></tr><tr><td></td><td><span class="name"><a name="alog-facilities.ads:103:7"></a>State</span></td><td>: Boolean);</td></tr></table></pre></div>
<div class='comment'>Enable/disable whether the source of the message is logged.
</div>
</div>
<div class="class">
<h3>
<a name='alog-facilities.ads:106:13' id='alog-facilities.ads:106:13'></a>
<span class="droplink">Is_Write_Source<ul>
<li><a href="src_alog-facilities.ads.html#l106">Goto spec in source</a></li>
</ul></span>
</h3>
<div class='details'><pre><span class="keyword">function</span> <span class="name_emphasis">Is_Write_Source</span> <table><tr><td>(</td><td><span class="name"><a name="alog-facilities.ads:106:30"></a>Facility</span></td><td>: <a href="alog-facilities.ads.html#alog-facilities.ads:41:12" title="defined at alog-facilities.ads:41:12">Class</a>) <span class="keyword">return</span> Boolean;</td></tr></table></pre></div>
<div class='comment'>Returns True if writing of log message sources is enabled.
</div>
</div>
<div class="class">
<h3>
<a name='alog-facilities.ads:109:14' id='alog-facilities.ads:109:14'></a>
<span class="droplink">Setup<ul>
<li><a href="src_alog-facilities.ads.html#l109">Goto spec in source</a></li>
</ul></span>
</h3>
<div class='details'><pre><span class="keyword">procedure</span> <span class="name_emphasis">Setup</span> <table><tr><td>(</td><td><span class="name"><a name="alog-facilities.ads:109:21"></a>Facility</span></td><td>: <span class="keyword">in</span> <span class="keyword">out</span> <a href="alog-facilities.ads.html#alog-facilities.ads:37:9" title="defined at alog-facilities.ads:37:9">Instance</a>) <span class="keyword">is</span> <span class="keyword">null</span>;</td></tr></table></pre></div>
<div class='comment'>Each facility must provide a <a href="alog-facilities.ads.html#alog-facilities.ads:109:14" title="Setup">Setup</a>-procedure. These procedures are
called by Logger instances when attaching <a href="alog-facilities.ads.html#alog-facilities.ads:32:14" title="Facilities">Facilities</a>. All needed
operations prior to writing log messages should be done here.
</div>
</div>
<div class="class">
<h3>
<a name='alog-facilities.ads:114:14' id='alog-facilities.ads:114:14'></a>
<span class="droplink">Teardown<ul>
<li><a href="src_alog-facilities.ads.html#l114">Goto spec in source</a></li>
</ul></span>
</h3>
<div class='details'><pre><span class="keyword">procedure</span> <span class="name_emphasis">Teardown</span> <table><tr><td>(</td><td><span class="name"><a name="alog-facilities.ads:114:24"></a>Facility</span></td><td>: <span class="keyword">in</span> <span class="keyword">out</span> <a href="alog-facilities.ads.html#alog-facilities.ads:37:9" title="defined at alog-facilities.ads:37:9">Instance</a>) <span class="keyword">is</span> <span class="keyword">null</span>;</td></tr></table></pre></div>
<div class='comment'>Each facility must provide a <a href="alog-facilities.ads.html#alog-facilities.ads:114:14" title="Teardown">Teardown</a>-procedure. These procedures are
called by Logger instances when detaching <a href="alog-facilities.ads.html#alog-facilities.ads:32:14" title="Facilities">Facilities</a> or when the logger
object gets out of scope.
</div>
</div>
</div>
</div> <!-- documentation -->
</body>
</html>
|