Index

Package: Alog.Facilities

Description

package Alog.Facilities is
Alog facilities package. Provides common data and methods used by all facilities.

Packages

BS_Path (new Generic_Bounded_Length)

package BS_Path is new Generic_Bounded_Length (Max_Path_Length);

Classes

Types

Class

subtype Class is Instance'Class;

References:

alog-facilities.ads:42:12 (declaration)
alog-facilities.adb:44:34 (reference)
alog-facilities.adb:52:18 (reference)
alog-facilities.adb:84:42 (reference)
alog-facilities.adb:91:43 (reference)
alog-facilities.adb:98:41 (reference)
alog-facilities.adb:105:44 (reference)
alog-facilities.adb:113:18 (reference)
alog-facilities.adb:151:25 (reference)
alog-facilities.adb:161:25 (reference)
alog-facilities.adb:171:25 (reference)
alog-facilities.adb:181:25 (reference)
alog-facilities.adb:191:25 (reference)
alog-facilities.ads:44:30 (reference)
alog-facilities.ads:52:25 (reference)
alog-facilities.ads:56:34 (reference)
alog-facilities.ads:60:18 (reference)
alog-facilities.ads:67:18 (reference)
alog-facilities.ads:79:25 (reference)
alog-facilities.ads:84:25 (reference)
alog-facilities.ads:88:44 (reference)
alog-facilities.ads:91:42 (reference)
alog-facilities.ads:95:25 (reference)
alog-facilities.ads:99:43 (reference)
alog-facilities.ads:103:25 (reference)
alog-facilities.ads:107:41 (reference)
alog-logger.ads:127:28 (reference)
alog-logger.ads:168:36 (reference)

Handle

type Handle is access all Class;

References:

alog-facilities.ads:44:9 (declaration)
alog-active_logger.adb:50:36 (reference)
alog-active_logger.ads:48:36 (reference)
alog-facilities.adb:35:15 (reference)
alog-facilities.adb:36:15 (reference)
alog-facilities.ads:47:15 (reference)
alog-facilities.ads:48:15 (reference)
alog-logger.adb:44:39 (reference)
alog-logger.adb:53:36 (reference)
alog-logger.adb:93:56 (reference)
alog-logger.adb:96:56 (reference)
alog-logger.adb:188:49 (reference)
alog-logger.adb:216:54 (reference)
alog-logger.adb:219:54 (reference)
alog-logger.adb:262:49 (reference)
alog-logger.adb:271:39 (reference)
alog-logger.ads:48:36 (reference)
alog-logger.ads:72:49 (reference)
alog-logger.ads:79:49 (reference)
alog-logger.ads:128:28 (reference)
alog-logger.ads:169:36 (reference)
alog-tasked_logger.adb:34:52 (reference)
alog-tasked_logger.adb:62:62 (reference)
alog-tasked_logger.ads:36:60 (reference)
alog-tasked_logger.ads:41:52 (reference)

Subprograms & Entries

=

function "="     
(Left: Handle;
Right: Handle)
return Boolean;

References:

alog-facilities.ads:46:13 (declaration)
alog-facilities.adb:34:13 (body)
alog-facilities.adb:40:8 (label)
Equal function.

Set_Name

procedure Set_Name     
(Facility: in out Class;
Name: String);

References:

alog-facilities.ads:51:14 (declaration)
alog-facilities.adb:150:14 (body)
alog-facilities.adb:156:8 (label)
alog-logger.adb:41:28 (reference)

Calls:

To_Unbounded_String defined at a-strunb.ads:57:13
Set facility name.

Get_Name

function Get_Name 
(Facility: Class)
return String;

References:

alog-facilities.ads:56:13 (declaration)
alog-facilities-smtp.adb:44:29 (reference)
alog-facilities.adb:39:19 (reference)
alog-facilities.adb:39:36 (reference)
alog-facilities.adb:44:13 (body)
alog-facilities.adb:47:8 (label)
alog-facilities.adb:122:33 (reference)
alog-logger.adb:56:39 (reference)

Called by:

= defined at alog-facilities.ads:46:13
= defined at alog-facilities.ads:46:13
Alog.Facilities.SMTP.Format_Message defined at alog-facilities-smtp.ads:79:13
Alog.Logger.Attach_Facility defined at alog-logger.ads:46:14
Process defined at alog-facilities.ads:66:14

Calls:

To_String defined at a-strunb.ads:63:13
Get facility name.

Get_Timestamp

function Get_Timestamp     
(Facility: Class;
Time: Ada.Calendar.Time := Ada.Calendar.Clock)
return String;

References:

alog-facilities.ads:59:13 (declaration)
alog-facilities-smtp.adb:43:36 (reference)
alog-facilities.adb:51:13 (body)
alog-facilities.adb:80:8 (label)
alog-facilities.adb:127:42 (reference)

Called by:

Alog.Facilities.SMTP.Format_Message defined at alog-facilities-smtp.ads:79:13
Process defined at alog-facilities.ads:66:14

Calls:

- defined at a-calend.ads:96:13
Clock defined at a-calend.ads:52:13
Image defined at g-catiio.ads:113:13
Is_UTC_Timestamp defined at alog-facilities.ads:91:13
UTC_Time_Offset defined at a-catizo.ads:29:13
Creates a timestamp and returns it as String. If no Time is given, the current time is used.

Process

procedure Process     
(Facility: Class;
Request: Log_Request.Instance);

References:

alog-facilities.ads:66:14 (declaration)
alog-facilities.adb:112:14 (body)
alog-facilities.adb:146:8 (label)
alog-logger.adb:227:26 (reference)

Called by:

Alog.Logger.Log_Message.Do_Log defined at alog-logger.adb:216:17
Process a log request.

Write (abstract)

procedure Write     
(Facility: Instance;
Level: Log_Level := Info;
Msg: String)
is abstract;

References:

alog-facilities.ads:71:14 (declaration)
alog-facilities.adb:143:19 (dispatching call)

Called by:

Process defined at alog-facilities.ads:66:14
Write message with specified log level. This procedure must be implemented by all facilities.

Toggle_Write_Timestamp

procedure Toggle_Write_Timestamp     
(Facility: in out Class;
State: Boolean);

References:

alog-facilities.ads:78:14 (declaration)
alog-facilities.adb:190:14 (body)
alog-facilities.adb:196:8 (label)
Enable/disable whether a timestamp is written for log messages.

Toggle_UTC_Timestamp

procedure Toggle_UTC_Timestamp     
(Facility: in out Class;
State: Boolean);

References:

alog-facilities.ads:83:14 (declaration)
alog-facilities.adb:160:14 (body)
alog-facilities.adb:166:8 (label)
Enable/disable UTC timestamps for log messages.

Is_Write_Timestamp

function Is_Write_Timestamp 
(Facility: Class)
return Boolean;

References:

alog-facilities.ads:88:13 (declaration)
alog-facilities.adb:105:13 (body)
alog-facilities.adb:108:8 (label)
alog-facilities.adb:125:22 (reference)

Called by:

Process defined at alog-facilities.ads:66:14
Returns the current value of Write_Timestamp.

Is_UTC_Timestamp

function Is_UTC_Timestamp 
(Facility: Class)
return Boolean;

References:

alog-facilities.ads:91:13 (declaration)
alog-facilities.adb:58:19 (reference)
alog-facilities.adb:84:13 (body)
alog-facilities.adb:87:8 (label)
Returns True if the timestamp of the facility is written in UTC time.

Toggle_Write_Loglevel

procedure Toggle_Write_Loglevel     
(Facility: in out Class;
State: Boolean);

References:

alog-facilities.ads:94:14 (declaration)
alog-facilities.adb:170:14 (body)
alog-facilities.adb:176:8 (label)
Enable/disable whether the loglevel is written for log messages.

Is_Write_Loglevel

function Is_Write_Loglevel 
(Facility: Class)
return Boolean;

References:

alog-facilities.ads:99:13 (declaration)
alog-facilities.adb:91:13 (body)
alog-facilities.adb:94:8 (label)
alog-facilities.adb:130:22 (reference)

Called by:

Process defined at alog-facilities.ads:66:14
Returns the current value of Write_Loglevel.

Toggle_Write_Source

procedure Toggle_Write_Source     
(Facility: in out Class;
State: Boolean);

References:

alog-facilities.ads:102:14 (declaration)
alog-facilities.adb:180:14 (body)
alog-facilities.adb:186:8 (label)
Enable/disable whether the source of the message is logged.

Is_Write_Source

function Is_Write_Source 
(Facility: Class)
return Boolean;

References:

alog-facilities.ads:107:13 (declaration)
alog-facilities.adb:98:13 (body)
alog-facilities.adb:101:8 (label)
alog-facilities.adb:135:49 (reference)

Called by:

Process defined at alog-facilities.ads:66:14
Returns True if writing of log message sources is enabled.

Setup

procedure Setup 
(Facility: in out Instance)
is null;

References:

alog-facilities.ads:110:14 (declaration)
Each facility must provide a Setup-procedure. These procedures are called by Logger instances when attaching Facilities. All needed operations prior to writing log messages should be done here.

Teardown

procedure Teardown 
(Facility: in out Instance)
is null;

References:

alog-facilities.ads:115:14 (declaration)
alog-logger.adb:98:17 (dispatching call)

Called by:

Alog.Logger.Clear.Teardown_Facility defined at alog-logger.adb:93:17
Each facility must provide a Teardown-procedure. These procedures are called by Logger instances when detaching Facilities or when the logger object gets out of scope.