File: ACE_Log_Msg_Backend.3

package info (click to toggle)
ace 5.2.1-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 26,856 kB
  • ctags: 18,677
  • sloc: cpp: 171,831; makefile: 48,840; sh: 10,192; perl: 8,582; exp: 787; yacc: 387; lex: 140; csh: 20
file content (72 lines) | stat: -rw-r--r-- 2,268 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
.TH ACE_Log_Msg_Backend 3 "1 Dec 2001" "ACE" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ACE_Log_Msg_Backend \- Define the interface for \fBACE_Log_Msg\fR backend strategies. 
.SH SYNOPSIS
.br
.PP
\fC#include <Log_Msg_Backend.h>\fR
.PP
Inherited by \fBACE_Log_Msg_IPC\fR.
.PP
.SS Public Methods

.in +1c
.ti -1c
.RI "virtual \fB~ACE_Log_Msg_Backend\fR (void)"
.br
.RI "\fINo-op virtual destructor.\fR"
.ti -1c
.RI "virtual int \fBopen\fR (const \fBACE_TCHAR\fR *logger_key) = 0"
.br
.RI "\fIOpen a new connection.\fR"
.ti -1c
.RI "virtual int \fBreset\fR (void) = 0"
.br
.ti -1c
.RI "virtual int \fBclose\fR (void) = 0"
.br
.RI "\fIClose the backend completely.\fR"
.ti -1c
.RI "virtual int \fBlog\fR (\fBACE_Log_Record\fR &log_record) = 0"
.br
.RI "\fIBackend routine. This is called when we want to log a message. Since this routine is pure virtual, it must be overwritten by the subclass.\fR"
.in -1c
.SH DETAILED DESCRIPTION
.PP 
Define the interface for \fBACE_Log_Msg\fR backend strategies.
.PP
.PP
 The \fBACE_Log_Msg\fR class can log to multiple backend strategies, for example, some send messages to a remote logger, others dump to a file, or simply to stderr. In the future we could define interfaces that log to the syslog daemon (on UNIX), the Event log (on NT) a temporary ring buffer, etc. 
.PP
.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION
.PP 
.SS ACE_Log_Msg_Backend::~ACE_Log_Msg_Backend (void)\fC [virtual]\fR
.PP
No-op virtual destructor.
.PP
.SH MEMBER FUNCTION DOCUMENTATION
.PP 
.SS int ACE_Log_Msg_Backend::close (void)\fC [pure virtual]\fR
.PP
Close the backend completely.
.PP
Reimplemented in \fBACE_Log_Msg_IPC\fR.
.SS int ACE_Log_Msg_Backend::log (\fBACE_Log_Record\fR & log_record)\fC [pure virtual]\fR
.PP
Backend routine. This is called when we want to log a message. Since this routine is pure virtual, it must be overwritten by the subclass.
.PP
Reimplemented in \fBACE_Log_Msg_IPC\fR.
.SS int ACE_Log_Msg_Backend::open (const \fBACE_TCHAR\fR * logger_key)\fC [pure virtual]\fR
.PP
Open a new connection.
.PP
Reimplemented in \fBACE_Log_Msg_IPC\fR.
.SS virtual int ACE_Log_Msg_Backend::reset (void)\fC [pure virtual]\fR
.PP
Reimplemented in \fBACE_Log_Msg_IPC\fR.

.SH AUTHOR
.PP 
Generated automatically by Doxygen for ACE from the source code.