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
|
<?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>
File: alog-tasked_logger.ads
</title>
<link rel='stylesheet' href='support/docgen.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='index.html'><div class="button2">Table of Contents</div></a>
<a href='tree.html'><div class="button2">Class Inheritance Tree</div></a>
</div>
</div>
</div> <!-- leftSide -->
<div class='subprograms'>
<div class='details'><ol><li id="l1"><pre><span class="comment">--</span> </pre></li>
<li id="l2"><pre><span class="comment">-- Copyright (c) 2009,</span> </pre></li>
<li id="l3"><pre><span class="comment">-- Reto Buerki, Adrian-Ken Rueegsegger</span> </pre></li>
<li id="l4"><pre><span class="comment">-- secunet SwissIT AG</span> </pre></li>
<li id="l5"><pre><span class="comment">--</span> </pre></li>
<li id="l6"><pre><span class="comment">-- This file is part of Alog.</span> </pre></li>
<li id="l7"><pre><span class="comment">--</span> </pre></li>
<li id="l8"><pre><span class="comment">-- Alog is free software; you can redistribute it and/or modify</span> </pre></li>
<li id="l9"><pre><span class="comment">-- it under the terms of the GNU Lesser General Public License as published</span> </pre></li>
<li id="l10"><pre><span class="comment">-- by the Free Software Foundation; either version 2.1 of the License, or</span> </pre></li>
<li id="l11"><pre><span class="comment">-- (at your option) any later version.</span> </pre></li>
<li id="l12"><pre><span class="comment">--</span> </pre></li>
<li id="l13"><pre><span class="comment">-- Alog is distributed in the hope that it will be useful,</span> </pre></li>
<li id="l14"><pre><span class="comment">-- but WITHOUT ANY WARRANTY; without even the implied warranty of</span> </pre></li>
<li id="l15"><pre><span class="comment">-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span> </pre></li>
<li id="l16"><pre><span class="comment">-- GNU Lesser General Public License for more details.</span> </pre></li>
<li id="l17"><pre><span class="comment">--</span> </pre></li>
<li id="l18"><pre><span class="comment">-- You should have received a copy of the GNU Lesser General Public License</span> </pre></li>
<li id="l19"><pre><span class="comment">-- along with Alog; if not, write to the Free Software</span> </pre></li>
<li id="l20"><pre><span class="comment">-- Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,</span> </pre></li>
<li id="l21"><pre><span class="comment">-- MA 02110-1301 USA</span> </pre></li>
<li id="l22"><pre><span class="comment">--</span> </pre></li>
<li id="l23"><pre> </pre></li>
<li id="l24"><pre><span class="keyword">with</span> Ada.Exceptions; </pre></li>
<li id="l25"><pre><span class="keyword">with</span> Ada.Task_Identification; </pre></li>
<li id="l26"><pre> </pre></li>
<li id="l27"><pre><span class="keyword">with</span> <span class="droplink">Alog.Facilities<ul><li><a href="alog-facilities.ads.html#alog-facilities.ads:33:14" title="To API doc">To API doc</a></li><li><a href="src_alog-facilities.ads.html#l33" title="To spec">To spec</a></li><li><a href="src_alog-facilities.adb.html#l30" title="To body">To body</a></li></ul></span>; </pre></li>
<li id="l28"><pre><span class="keyword">with</span> <span class="droplink">Alog.Transforms<ul><li><a href="alog-transforms.ads.html#alog-transforms.ads:27:14" title="To API doc">To API doc</a></li><li><a href="src_alog-transforms.ads.html#l27" title="To spec">To spec</a></li><li><a href="src_alog-transforms.adb.html#l24" title="To body">To body</a></li></ul></span>; </pre></li>
<li id="l29"><pre> </pre></li>
<li id="l30"><pre><span class="comment">-- Tasked Logger instance. Facilities can be attached to this logger instance</span> </pre></li>
<li id="l31"><pre><span class="comment">-- in order to log to different targets simultaneously. This instance provides</span> </pre></li>
<li id="l32"><pre><span class="comment">-- task-safe concurrent logging.</span> </pre></li>
<li id="l33"><pre><span class="keyword">package</span> <span class="droplink">Alog.Tasked_Logger<ul><li><a href="alog-tasked_logger.ads.html#alog-tasked_logger.ads:33:14" title="To API doc">To API doc</a></li><li><a href="src_alog-tasked_logger.ads.html#l33" title="To spec">To spec</a></li><li><a href="src_alog-tasked_logger.adb.html#l29" title="To body">To body</a></li></ul></span> <span class="keyword">is</span> </pre></li>
<li id="l34"><pre> </pre></li>
<li id="l35"><pre> <span class="keyword">type</span> <a href="alog-tasked_logger.ads.html#alog-tasked_logger.ads:35:9" title="defined at alog-tasked_logger.ads:35:9">Facility_Update_Handle</a> <span class="keyword">is</span> </pre></li>
<li id="l36"><pre> <span class="keyword">not</span> <span class="keyword">null</span> <span class="keyword">access</span> <span class="keyword">procedure</span> (Facility_Handle : <span class="droplink">Facilities.Handle<ul><li><a href="alog-facilities.ads.html#alog-facilities.ads:44:9" title="To API doc">To API doc</a></li><li><a href="src_alog-facilities.ads.html#l44" title="To spec">To spec</a></li></ul></span>); </pre></li>
<li id="l37"><pre> <span class="comment">-- Handle to facility update procedure.</span> </pre></li>
<li id="l38"><pre> </pre></li>
<li id="l39"><pre> <span class="keyword">task</span> <span class="keyword">type</span> <span class="droplink">Instance<ul><li><a href="alog-tasked_logger.ads.html#alog-tasked_logger.ads:39:14" title="To API doc">To API doc</a></li><li><a href="src_alog-tasked_logger.adb.html#l41" title="To body">To body</a></li></ul></span> (<a href="alog-tasked_logger.ads.html#alog-tasked_logger.ads:39:24" title="defined at alog-tasked_logger.ads:39:24">Init</a> : Boolean := False) <span class="keyword">is</span> </pre></li>
<li id="l40"><pre> </pre></li>
<li id="l41"><pre> <span class="keyword">entry</span> <span class="droplink">Attach_Facility<ul><li><a href="alog-tasked_logger.ads.html#alog-tasked_logger.ads:41:13" title="To API doc">To API doc</a></li><li><a href="src_alog-tasked_logger.adb.html#l62" title="To body">To body</a></li></ul></span> (<a href="alog-tasked_logger.ads.html#alog-tasked_logger.ads:41:30" title="defined at alog-tasked_logger.ads:41:30">Facility</a> : <span class="droplink">Facilities.Handle<ul><li><a href="alog-facilities.ads.html#alog-facilities.ads:44:9" title="To API doc">To API doc</a></li><li><a href="src_alog-facilities.ads.html#l44" title="To spec">To spec</a></li></ul></span>); </pre></li>
<li id="l42"><pre> <span class="comment">-- Attach a facility to tasked logger instance.</span> </pre></li>
<li id="l43"><pre> </pre></li>
<li id="l44"><pre> <span class="keyword">entry</span> <span class="droplink">Attach_Default_Facility<ul><li><a href="alog-tasked_logger.ads.html#alog-tasked_logger.ads:44:13" title="To API doc">To API doc</a></li><li><a href="src_alog-tasked_logger.adb.html#l69" title="To body">To body</a></li></ul></span>; </pre></li>
<li id="l45"><pre> <span class="comment">-- Attach default facility to tasked logger instance.</span> </pre></li>
<li id="l46"><pre> </pre></li>
<li id="l47"><pre> <span class="keyword">entry</span> <span class="droplink">Detach_Facility<ul><li><a href="alog-tasked_logger.ads.html#alog-tasked_logger.ads:47:13" title="To API doc">To API doc</a></li><li><a href="src_alog-tasked_logger.adb.html#l76" title="To body">To body</a></li></ul></span> (<a href="alog-tasked_logger.ads.html#alog-tasked_logger.ads:47:30" title="defined at alog-tasked_logger.ads:47:30">Name</a> : String); </pre></li>
<li id="l48"><pre> <span class="comment">-- Detach a facility from tasked logger instance.</span> </pre></li>
<li id="l49"><pre> </pre></li>
<li id="l50"><pre> <span class="keyword">entry</span> <span class="droplink">Detach_Default_Facility<ul><li><a href="alog-tasked_logger.ads.html#alog-tasked_logger.ads:50:13" title="To API doc">To API doc</a></li><li><a href="src_alog-tasked_logger.adb.html#l83" title="To body">To body</a></li></ul></span>; </pre></li>
<li id="l51"><pre> <span class="comment">-- Detach default facility from tasked logger instance.</span> </pre></li>
<li id="l52"><pre> </pre></li>
<li id="l53"><pre> <span class="keyword">entry</span> <span class="droplink">Facility_Count<ul><li><a href="alog-tasked_logger.ads.html#alog-tasked_logger.ads:53:13" title="To API doc">To API doc</a></li><li><a href="src_alog-tasked_logger.adb.html#l90" title="To body">To body</a></li></ul></span> (<a href="alog-tasked_logger.ads.html#alog-tasked_logger.ads:53:29" title="defined at alog-tasked_logger.ads:53:29">Count</a> : <span class="keyword">out</span> Natural); </pre></li>
<li id="l54"><pre> <span class="comment">-- Return number of attached facilites.</span> </pre></li>
<li id="l55"><pre> </pre></li>
<li id="l56"><pre> <span class="keyword">entry</span> <span class="droplink">Update<ul><li><a href="alog-tasked_logger.ads.html#alog-tasked_logger.ads:56:13" title="To API doc">To API doc</a></li><li><a href="src_alog-tasked_logger.adb.html#l97" title="To body">To body</a></li></ul></span> </pre></li>
<li id="l57"><pre> (<a href="alog-tasked_logger.ads.html#alog-tasked_logger.ads:57:10" title="defined at alog-tasked_logger.ads:57:10">Name</a> : String; </pre></li>
<li id="l58"><pre> <a href="alog-tasked_logger.ads.html#alog-tasked_logger.ads:58:10" title="defined at alog-tasked_logger.ads:58:10">Process</a> : <span class="droplink">Facility_Update_Handle<ul><li><a href="alog-tasked_logger.ads.html#alog-tasked_logger.ads:35:9" title="To API doc">To API doc</a></li><li><a href="src_alog-tasked_logger.ads.html#l35" title="To spec">To spec</a></li></ul></span>); </pre></li>
<li id="l59"><pre> <span class="comment">-- Update a specific facility identified by 'Name'. Call the 'Process'</span> </pre></li>
<li id="l60"><pre> <span class="comment">-- procedure to perform the update operation. Clear the last exception</span> </pre></li>
<li id="l61"><pre> <span class="comment">-- occurrence for the caller if none occurred or replace existing</span> </pre></li>
<li id="l62"><pre> <span class="comment">-- occurrence with new raised exception.</span> </pre></li>
<li id="l63"><pre> </pre></li>
<li id="l64"><pre> <span class="keyword">entry</span> <span class="droplink">Iterate<ul><li><a href="alog-tasked_logger.ads.html#alog-tasked_logger.ads:64:13" title="To API doc">To API doc</a></li><li><a href="src_alog-tasked_logger.adb.html#l124" title="To body">To body</a></li></ul></span> (<a href="alog-tasked_logger.ads.html#alog-tasked_logger.ads:64:22" title="defined at alog-tasked_logger.ads:64:22">Process</a> : <span class="droplink">Facility_Update_Handle<ul><li><a href="alog-tasked_logger.ads.html#alog-tasked_logger.ads:35:9" title="To API doc">To API doc</a></li><li><a href="src_alog-tasked_logger.ads.html#l35" title="To spec">To spec</a></li></ul></span>); </pre></li>
<li id="l65"><pre> <span class="comment">-- Call 'Process' for all attached facilities.</span> </pre></li>
<li id="l66"><pre> </pre></li>
<li id="l67"><pre> <span class="keyword">entry</span> <span class="droplink">Attach_Transform<ul><li><a href="alog-tasked_logger.ads.html#alog-tasked_logger.ads:67:13" title="To API doc">To API doc</a></li><li><a href="src_alog-tasked_logger.adb.html#l146" title="To body">To body</a></li></ul></span> (<a href="alog-tasked_logger.ads.html#alog-tasked_logger.ads:67:31" title="defined at alog-tasked_logger.ads:67:31">Transform</a> : <span class="droplink">Transforms.Handle<ul><li><a href="alog-transforms.ads.html#alog-transforms.ads:37:9" title="To API doc">To API doc</a></li><li><a href="src_alog-transforms.ads.html#l37" title="To spec">To spec</a></li></ul></span>); </pre></li>
<li id="l68"><pre> <span class="comment">-- Attach a transform to tasked logger instance.</span> </pre></li>
<li id="l69"><pre> </pre></li>
<li id="l70"><pre> <span class="keyword">entry</span> <span class="droplink">Detach_Transform<ul><li><a href="alog-tasked_logger.ads.html#alog-tasked_logger.ads:70:13" title="To API doc">To API doc</a></li><li><a href="src_alog-tasked_logger.adb.html#l153" title="To body">To body</a></li></ul></span> (<a href="alog-tasked_logger.ads.html#alog-tasked_logger.ads:70:31" title="defined at alog-tasked_logger.ads:70:31">Name</a> : String); </pre></li>
<li id="l71"><pre> <span class="comment">-- Detach a transform from tasked logger instance.</span> </pre></li>
<li id="l72"><pre> </pre></li>
<li id="l73"><pre> <span class="keyword">entry</span> <span class="droplink">Transform_Count<ul><li><a href="alog-tasked_logger.ads.html#alog-tasked_logger.ads:73:13" title="To API doc">To API doc</a></li><li><a href="src_alog-tasked_logger.adb.html#l160" title="To body">To body</a></li></ul></span> (<a href="alog-tasked_logger.ads.html#alog-tasked_logger.ads:73:30" title="defined at alog-tasked_logger.ads:73:30">Count</a> : <span class="keyword">out</span> Natural); </pre></li>
<li id="l74"><pre> <span class="comment">-- Return number of attached transforms.</span> </pre></li>
<li id="l75"><pre> </pre></li>
<li id="l76"><pre> <span class="keyword">entry</span> <span class="droplink">Log_Message<ul><li><a href="alog-tasked_logger.ads.html#alog-tasked_logger.ads:76:13" title="To API doc">To API doc</a></li><li><a href="src_alog-tasked_logger.adb.html#l198" title="To body">To body</a></li></ul></span> </pre></li>
<li id="l77"><pre> (<a href="alog-tasked_logger.ads.html#alog-tasked_logger.ads:77:10" title="defined at alog-tasked_logger.ads:77:10">Source</a> : String := <span class="string">""</span>; </pre></li>
<li id="l78"><pre> <a href="alog-tasked_logger.ads.html#alog-tasked_logger.ads:78:10" title="defined at alog-tasked_logger.ads:78:10">Level</a> : <span class="droplink">Log_Level<ul><li><a href="alog.ads.html#alog.ads:32:9" title="To API doc">To API doc</a></li><li><a href="src_alog.ads.html#l32" title="To spec">To spec</a></li></ul></span>; </pre></li>
<li id="l79"><pre> <a href="alog-tasked_logger.ads.html#alog-tasked_logger.ads:79:10" title="defined at alog-tasked_logger.ads:79:10">Msg</a> : String; </pre></li>
<li id="l80"><pre> <a href="alog-tasked_logger.ads.html#alog-tasked_logger.ads:80:10" title="defined at alog-tasked_logger.ads:80:10">Caller</a> : Ada.Task_Identification.Task_Id := </pre></li>
<li id="l81"><pre> Ada.Task_Identification.Null_Task_Id); </pre></li>
<li id="l82"><pre> <span class="comment">-- Log a message. The Write_Message() procedure of all attached</span> </pre></li>
<li id="l83"><pre> <span class="comment">-- facilities is called. Depending on the Log-Threshold set, the message</span> </pre></li>
<li id="l84"><pre> <span class="comment">-- is logged to different targets (depending on the facilites)</span> </pre></li>
<li id="l85"><pre> <span class="comment">-- automatically. Clear the last exception occurrence for the caller if</span> </pre></li>
<li id="l86"><pre> <span class="comment">-- none occurred or replace existing occurrence with new raised</span> </pre></li>
<li id="l87"><pre> <span class="comment">-- exception.</span> </pre></li>
<li id="l88"><pre> <span class="comment">-- If caller is not specified the executing task's ID is used instead.</span> </pre></li>
<li id="l89"><pre> <span class="comment">-- Since Log_Message'Caller can not be used as default parameter the</span> </pre></li>
<li id="l90"><pre> <span class="comment">-- entry checks if the variable is set to 'Null_Task_Id' in the body.</span> </pre></li>
<li id="l91"><pre> <span class="comment">--</span> </pre></li>
<li id="l92"><pre> <span class="comment">-- Prior to actually processing the given log message the policy database</span> </pre></li>
<li id="l93"><pre> <span class="comment">-- is inquired if the log message with given source and level should be</span> </pre></li>
<li id="l94"><pre> <span class="comment">-- logged.</span> </pre></li>
<li id="l95"><pre> </pre></li>
<li id="l96"><pre> <span class="keyword">entry</span> <span class="droplink">Clear<ul><li><a href="alog-tasked_logger.ads.html#alog-tasked_logger.ads:96:13" title="To API doc">To API doc</a></li><li><a href="src_alog-tasked_logger.adb.html#l168" title="To body">To body</a></li></ul></span>; </pre></li>
<li id="l97"><pre> <span class="comment">-- Clear tasked logger instance. Detach and teardown all attached</span> </pre></li>
<li id="l98"><pre> <span class="comment">-- facilities and transforms and clear any stored exceptions.</span> </pre></li>
<li id="l99"><pre> </pre></li>
<li id="l100"><pre> <span class="keyword">entry</span> <span class="droplink">Get_Last_Exception<ul><li><a href="alog-tasked_logger.ads.html#alog-tasked_logger.ads:100:13" title="To API doc">To API doc</a></li><li><a href="src_alog-tasked_logger.adb.html#l176" title="To body">To body</a></li></ul></span> </pre></li>
<li id="l101"><pre> (<a href="alog-tasked_logger.ads.html#alog-tasked_logger.ads:101:10" title="defined at alog-tasked_logger.ads:101:10">Occurrence</a> : <span class="keyword">out</span> Ada.Exceptions.Exception_Occurrence; </pre></li>
<li id="l102"><pre> <a href="alog-tasked_logger.ads.html#alog-tasked_logger.ads:102:10" title="defined at alog-tasked_logger.ads:102:10">Caller</a> : Ada.Task_Identification.Task_Id := </pre></li>
<li id="l103"><pre> Ada.Task_Identification.Null_Task_Id); </pre></li>
<li id="l104"><pre> <span class="comment">-- Return last known Exception_Occurrence. If no exception occured return</span> </pre></li>
<li id="l105"><pre> <span class="comment">-- Null_Occurrence.</span> </pre></li>
<li id="l106"><pre> <span class="comment">-- If caller is not specified the executing task's ID is used instead.</span> </pre></li>
<li id="l107"><pre> <span class="comment">-- Since Get_Last_Exception'Caller can not be used as default parameter</span> </pre></li>
<li id="l108"><pre> <span class="comment">-- the entry checks if the variable is set to 'Null_Task_Id' in the body.</span> </pre></li>
<li id="l109"><pre> </pre></li>
<li id="l110"><pre> <span class="keyword">entry</span> <span class="droplink">Shutdown<ul><li><a href="alog-tasked_logger.ads.html#alog-tasked_logger.ads:110:13" title="To API doc">To API doc</a></li><li><a href="src_alog-tasked_logger.adb.html#l241" title="To body">To body</a></li></ul></span>; </pre></li>
<li id="l111"><pre> <span class="comment">-- Explicitly shutdown tasked logger.</span> </pre></li>
<li id="l112"><pre> </pre></li>
<li id="l113"><pre> <span class="keyword">end</span> <span class="droplink">Instance<ul><li><a href="alog-tasked_logger.ads.html#alog-tasked_logger.ads:39:14" title="To API doc">To API doc</a></li><li><a href="src_alog-tasked_logger.ads.html#l39" title="To spec">To spec</a></li><li><a href="src_alog-tasked_logger.adb.html#l41" title="To body">To body</a></li></ul></span>; </pre></li>
<li id="l114"><pre> <span class="comment">-- Tasked logger instance. The Init discriminant defines whether or not a</span> </pre></li>
<li id="l115"><pre> <span class="comment">-- default 'stdout' (FD facility without logfile set) is attached</span> </pre></li>
<li id="l116"><pre> <span class="comment">-- automatically. Default is 'False'. Set Init to 'True' if you want to make</span> </pre></li>
<li id="l117"><pre> <span class="comment">-- sure minimal stdout logging is possible as soon as a new logger is</span> </pre></li>
<li id="l118"><pre> <span class="comment">-- instantiated.</span> </pre></li>
<li id="l119"><pre> </pre></li>
<li id="l120"><pre> <span class="keyword">type</span> <a href="alog-tasked_logger.ads.html#alog-tasked_logger.ads:120:9" title="defined at alog-tasked_logger.ads:120:9">Handle</a> <span class="keyword">is</span> <span class="keyword">access</span> <span class="keyword">all</span> <span class="droplink">Instance<ul><li><a href="alog-tasked_logger.ads.html#alog-tasked_logger.ads:39:14" title="To API doc">To API doc</a></li><li><a href="src_alog-tasked_logger.ads.html#l39" title="To spec">To spec</a></li><li><a href="src_alog-tasked_logger.adb.html#l41" title="To body">To body</a></li></ul></span>; </pre></li>
<li id="l121"><pre> <span class="comment">-- Handle to tasked logger type.</span> </pre></li>
<li id="l122"><pre> </pre></li>
<li id="l123"><pre><span class="keyword">end</span> <span class="droplink">Alog.Tasked_Logger<ul><li><a href="alog-tasked_logger.ads.html#alog-tasked_logger.ads:33:14" title="To API doc">To API doc</a></li><li><a href="src_alog-tasked_logger.ads.html#l33" title="To spec">To spec</a></li><li><a href="src_alog-tasked_logger.adb.html#l29" title="To body">To body</a></li></ul></span>; </pre></li>
</ol></div>
</div>
</body>
</html>
|
