File: src_alog-log_request.ads.html

package info (click to toggle)
libalog 0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 2,056 kB
  • ctags: 465
  • sloc: ada: 5,203; makefile: 166; sql: 9; sh: 2
file content (98 lines) | stat: -rw-r--r-- 12,604 bytes parent folder | download 
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
 
<?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-log_request.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.Task_Identification; </pre></li>
<li id="l25"><pre><span class="keyword">with</span> Ada.Strings.Unbounded; </pre></li>
<li id="l26"><pre> </pre></li>
<li id="l27"><pre><span class="comment">--  Log request type. Log request objects are used for asynchronous logging and</span> </pre></li>
<li id="l28"><pre><span class="comment">--  hold all relevant information of a log request.</span> </pre></li>
<li id="l29"><pre><span class="keyword">package</span> <span class="droplink">Alog.Log_Request<ul><li><a href="alog-log_request.ads.html#alog-log_request.ads:29:14" title="To API doc">To API doc</a></li><li><a href="src_alog-log_request.ads.html#l29" title="To spec">To spec</a></li><li><a href="src_alog-log_request.adb.html#l24" title="To body">To body</a></li></ul></span> <span class="keyword">is</span> </pre></li>
<li id="l30"><pre> </pre></li>
<li id="l31"><pre>   <span class="keyword">use</span> Ada.Task_Identification; </pre></li>
<li id="l32"><pre> </pre></li>
<li id="l33"><pre>   <span class="keyword">type</span> <span class="droplink">Instance<ul><li><a href="alog-log_request.ads.html#alog-log_request.ads:33:9" title="To API doc">To API doc</a></li><li><a href="src_alog-log_request.ads.html#l59" title="To body">To body</a></li></ul></span> <span class="keyword">is</span> <span class="keyword">tagged</span> <span class="keyword">private</span>; </pre></li>
<li id="l34"><pre>   <span class="comment">--  A log request contains all related information to log asynchronously</span> </pre></li>
<li id="l35"><pre>   <span class="comment">--  (Caller identification, loglevel and message).</span> </pre></li>
<li id="l36"><pre> </pre></li>
<li id="l37"><pre>   <span class="keyword">function</span> <span class="droplink">Create<ul><li><a href="alog-log_request.ads.html#alog-log_request.ads:37:13" title="To API doc">To API doc</a></li><li><a href="src_alog-log_request.adb.html#l30" title="To body">To body</a></li></ul></span> </pre></li>
<li id="l38"><pre>     (<a href="alog-log_request.ads.html#alog-log_request.ads:38:7" title="defined at alog-log_request.ads:38:7">ID</a>      : Task_Id   := Current_Task; </pre></li>
<li id="l39"><pre>      <a href="alog-log_request.ads.html#alog-log_request.ads:39:7" title="defined at alog-log_request.ads:39:7">Source</a>  : String    := <span class="string">&quot;&quot;</span>; </pre></li>
<li id="l40"><pre>      <span class="droplink">Level<ul><li><a href="alog-log_request.ads.html#alog-log_request.ads:40:7" title="To API doc">To API doc</a></li><li><a href="src_alog-log_request.adb.html#l33" title="To body">To body</a></li></ul></span>   : <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> := Debug; </pre></li>
<li id="l41"><pre>      <a href="alog-log_request.ads.html#alog-log_request.ads:41:7" title="defined at alog-log_request.ads:41:7">Message</a> : String) </pre></li>
<li id="l42"><pre>      <span class="keyword">return</span> <span class="droplink">Instance<ul><li><a href="alog-log_request.ads.html#alog-log_request.ads:33:9" title="To API doc">To API doc</a></li><li><a href="src_alog-log_request.ads.html#l33" title="To spec">To spec</a></li><li><a href="src_alog-log_request.ads.html#l59" title="To body">To body</a></li></ul></span>; </pre></li>
<li id="l43"><pre>   <span class="comment">--  Create a log request object from the specified parameters.</span> </pre></li>
<li id="l44"><pre> </pre></li>
<li id="l45"><pre>   <span class="keyword">function</span> <span class="droplink">Get_Caller_ID<ul><li><a href="alog-log_request.ads.html#alog-log_request.ads:45:13" title="To API doc">To API doc</a></li><li><a href="src_alog-log_request.adb.html#l46" title="To body">To body</a></li></ul></span> (<span class="droplink">Request<ul><li><a href="alog-log_request.ads.html#alog-log_request.ads:45:28" title="To API doc">To API doc</a></li><li><a href="src_alog-log_request.adb.html#l46" title="To body">To body</a></li></ul></span> : <span class="droplink">Instance<ul><li><a href="alog-log_request.ads.html#alog-log_request.ads:33:9" title="To API doc">To API doc</a></li><li><a href="src_alog-log_request.ads.html#l33" title="To spec">To spec</a></li><li><a href="src_alog-log_request.ads.html#l59" title="To body">To body</a></li></ul></span>) <span class="keyword">return</span> Task_Id; </pre></li>
<li id="l46"><pre>   <span class="comment">--  Return the caller ID of the request object.</span> </pre></li>
<li id="l47"><pre> </pre></li>
<li id="l48"><pre>   <span class="keyword">function</span> <span class="droplink">Get_Source<ul><li><a href="alog-log_request.ads.html#alog-log_request.ads:48:13" title="To API doc">To API doc</a></li><li><a href="src_alog-log_request.adb.html#l67" title="To body">To body</a></li></ul></span> (<span class="droplink">Request<ul><li><a href="alog-log_request.ads.html#alog-log_request.ads:48:25" title="To API doc">To API doc</a></li><li><a href="src_alog-log_request.adb.html#l67" title="To body">To body</a></li></ul></span> : <span class="droplink">Instance<ul><li><a href="alog-log_request.ads.html#alog-log_request.ads:33:9" title="To API doc">To API doc</a></li><li><a href="src_alog-log_request.ads.html#l33" title="To spec">To spec</a></li><li><a href="src_alog-log_request.ads.html#l59" title="To body">To body</a></li></ul></span>) <span class="keyword">return</span> String; </pre></li>
<li id="l49"><pre>   <span class="comment">--  Return the source of the request object.</span> </pre></li>
<li id="l50"><pre> </pre></li>
<li id="l51"><pre>   <span class="keyword">function</span> <span class="droplink">Get_Log_Level<ul><li><a href="alog-log_request.ads.html#alog-log_request.ads:51:13" title="To API doc">To API doc</a></li><li><a href="src_alog-log_request.adb.html#l53" title="To body">To body</a></li></ul></span> (<span class="droplink">Request<ul><li><a href="alog-log_request.ads.html#alog-log_request.ads:51:28" title="To API doc">To API doc</a></li><li><a href="src_alog-log_request.adb.html#l53" title="To body">To body</a></li></ul></span> : <span class="droplink">Instance<ul><li><a href="alog-log_request.ads.html#alog-log_request.ads:33:9" title="To API doc">To API doc</a></li><li><a href="src_alog-log_request.ads.html#l33" title="To spec">To spec</a></li><li><a href="src_alog-log_request.ads.html#l59" title="To body">To body</a></li></ul></span>) <span class="keyword">return</span> <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="l52"><pre>   <span class="comment">--  Return the loglevel of the request object.</span> </pre></li>
<li id="l53"><pre> </pre></li>
<li id="l54"><pre>   <span class="keyword">function</span> <span class="droplink">Get_Message<ul><li><a href="alog-log_request.ads.html#alog-log_request.ads:54:13" title="To API doc">To API doc</a></li><li><a href="src_alog-log_request.adb.html#l60" title="To body">To body</a></li></ul></span> (<span class="droplink">Request<ul><li><a href="alog-log_request.ads.html#alog-log_request.ads:54:26" title="To API doc">To API doc</a></li><li><a href="src_alog-log_request.adb.html#l60" title="To body">To body</a></li></ul></span> : <span class="droplink">Instance<ul><li><a href="alog-log_request.ads.html#alog-log_request.ads:33:9" title="To API doc">To API doc</a></li><li><a href="src_alog-log_request.ads.html#l33" title="To spec">To spec</a></li><li><a href="src_alog-log_request.ads.html#l59" title="To body">To body</a></li></ul></span>) <span class="keyword">return</span> String; </pre></li>
<li id="l55"><pre>   <span class="comment">--  Return the log message of the request object.</span> </pre></li>
<li id="l56"><pre> </pre></li>
<li id="l57"><pre><span class="keyword">private</span> </pre></li>
<li id="l58"><pre> </pre></li>
<li id="l59"><pre>   <span class="keyword">type</span> <span class="droplink">Instance<ul><li><a href="alog-log_request.ads.html#alog-log_request.ads:33:9" title="To API doc">To API doc</a></li><li><a href="src_alog-log_request.ads.html#l33" title="To spec">To spec</a></li></ul></span> <span class="keyword">is</span> <span class="keyword">tagged</span> <span class="keyword">record</span> </pre></li>
<li id="l60"><pre>      Caller_ID : Task_Id   := Null_Task_Id; </pre></li>
<li id="l61"><pre>      Source    : Ada.Strings.Unbounded.Unbounded_String; </pre></li>
<li id="l62"><pre>      Level     : <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> := Info; </pre></li>
<li id="l63"><pre>      Message   : Ada.Strings.Unbounded.Unbounded_String; </pre></li>
<li id="l64"><pre>   <span class="keyword">end</span> <span class="keyword">record</span>; </pre></li>
<li id="l65"><pre> </pre></li>
<li id="l66"><pre><span class="keyword">end</span> <span class="droplink">Alog.Log_Request<ul><li><a href="alog-log_request.ads.html#alog-log_request.ads:29:14" title="To API doc">To API doc</a></li><li><a href="src_alog-log_request.ads.html#l29" title="To spec">To spec</a></li><li><a href="src_alog-log_request.adb.html#l24" title="To body">To body</a></li></ul></span>; </pre></li>
</ol></div>
</div>

</body>
</html>