Index

Package: Alog.Facilities.File_Descriptor

Description

package Alog.Facilities.File_Descriptor is
File_Descriptor facility. Used to log to a console or file. If no file is specified by a Set_Logfile()-call, console logging is used.

Classes

Instance

type Instance is new Alog.Facilities.Instance with private;

Ancestors:

Primitive operations:

Alog.Facilities.Setup (Inherited)
Close_Logfile
Write (overriding Alog.Facilities.Write)

References:

alog-facilities-file_descriptor.ads:30:9 (declaration)
alog-facilities-file_descriptor.adb:32:25 (reference)
alog-facilities-file_descriptor.adb:51:37 (reference)
alog-facilities-file_descriptor.adb:60:25 (reference)
alog-facilities-file_descriptor.adb:100:42 (reference)
alog-facilities-file_descriptor.adb:108:18 (reference)
alog-facilities-file_descriptor.ads:33:30 (reference)
alog-facilities-file_descriptor.ads:36:42 (reference)
alog-facilities-file_descriptor.ads:40:25 (reference)
alog-facilities-file_descriptor.ads:46:37 (reference)
alog-facilities-file_descriptor.ads:50:25 (reference)
alog-facilities-file_descriptor.ads:62:18 (reference)
alog-facilities-file_descriptor.ads:67:9 (full declaration)
alog-logger.adb:40:62 (reference)
File Descriptor based logging facility.

Types

Handle

type Handle is access all Instance;

References:

alog-facilities-file_descriptor.ads:33:9 (declaration)
alog-logger.adb:38:57 (reference)

Constants & Global variables

Open_File_Error

Open_File_Error : exception;

References:

alog-facilities-file_descriptor.ads:54:4 (declaration)
alog-facilities-file_descriptor.adb:94:16 (reference)
This exception is raised if an error occurs while trying to open a logfile.

Subprograms & Entries

Teardown

procedure Teardown 
(Facility: in out Instance);

References:

alog-facilities-file_descriptor.ads:36:14 (declaration)
alog-facilities-file_descriptor.adb:100:14 (body)
alog-facilities-file_descriptor.adb:103:8 (label)
Implementation of Teardown-procedure.

Set_Logfile

procedure Set_Logfile     
(Facility: in out Instance;
Path: String;
Append: Boolean := True);

References:

alog-facilities-file_descriptor.ads:39:14 (declaration)
alog-facilities-file_descriptor.adb:59:14 (body)
alog-facilities-file_descriptor.adb:96:8 (label)

Calls:

Create defined at a-textio.ads:86:14
Exception_Message defined at a-except.ads:97:13
Exists defined at a-direct.ads:241:13
Open defined at a-textio.ads:92:14
To_Bounded_String defined at a-strbou.ads:63:16
Set logfile to use. If not set, standard output is used for logging. Set Append to False if an existing logfile should be overwritten.

Get_Logfile

function Get_Logfile 
(Facility: Instance)
return Ada.Text_IO.File_Access;

References:

alog-facilities-file_descriptor.ads:46:13 (declaration)
alog-facilities-file_descriptor.adb:51:13 (body)
alog-facilities-file_descriptor.adb:55:8 (label)
Get currently used logfile.

Close_Logfile

procedure Close_Logfile     
(Facility: in out Instance;
Remove: Boolean := False);

References:

alog-facilities-file_descriptor.ads:49:14 (declaration)
alog-facilities-file_descriptor.adb:31:14 (body)
alog-facilities-file_descriptor.adb:47:8 (label)
alog-facilities-file_descriptor.adb:102:16 (reference)

Calls:

Close defined at a-textio.ads:98:14
Delete defined at a-textio.ads:99:14
Is_Open defined at a-textio.ads:107:13
Standard_Output defined at a-textio.ads:128:13
Close opened logfile.