Changeset ebc67925 in rtems


Ignore:
Timestamp:
Aug 10, 1998, 2:53:01 PM (21 years ago)
Author:
Wade A Smith <warm38@…>
Branches:
4.10, 4.11, 4.8, 4.9, master
Children:
b044905b
Parents:
8c82d8d1
Message:

Documented the following Event Logging routines:
log_write, log_open, log_read, log_notify, log_close, log_seek,
log_severity_before, log_facilityemptyset, log_facilityfillset,
log_facilityaddset, log_facilitydelset, and log_facilityismember

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/new_chapters/eventlog.t

    r8c82d8d1 rebc67925  
    1717
    1818@itemize @bullet
    19 @item @code{log_write} -
    20 @item @code{log_open} -
    21 @item @code{log_read} -
    22 @item @code{log_notify} -
    23 @item @code{log_close} -
    24 @item @code{log_seek} -
    25 @item @code{log_severity_before} -
    26 @item @code{log_facilityemptyset} -
    27 @item @code{log_facilityfillset} -
    28 @item @code{log_facilityaddset} -
    29 @item @code{log_facilitydelset} -
    30 @item @code{log_facilityismember} -
     19@item @code{log_write} - Write to the Log
     20@item @code{log_open} - Open a log file
     21@item @code{log_read} - Read from the system Log
     22@item @code{log_notify} - Notify Process of writes to the system log
     23@item @code{log_close} - Close log descriptor
     24@item @code{log_seek} - Reposition log file offset
     25@item @code{log_severity_before} - Compare event record severities
     26@item @code{log_facilityemptyset} - Manipulate log facility sets
     27@item @code{log_facilityfillset} - Manipulate log facility sets
     28@item @code{log_facilityaddset} - Manipulate log facility sets
     29@item @code{log_facilitydelset} - Manipulate log facility sets
     30@item @code{log_facilityismember} - Manipulate log facility sets
    3131@end itemize
    3232
     
    4343
    4444@page
    45 @subsection log_write -
     45@subsection log_write - Write to the Log
    4646
    4747@subheading CALLING SEQUENCE:
     
    5050@example
    5151int log_write(
    52 );
    53 @end example
    54 @end ifset
    55 
    56 @ifset is-Ada
    57 @end ifset
    58 
    59 @subheading STATUS CODES:
    60 
    61 @table @b
    62 @item E
    63 The
    64 
    65 @end table
    66 
    67 @subheading DESCRIPTION:
    68 
    69 @subheading NOTES:
    70 
    71 @page
    72 @subsection log_open -
     52  const log_facility_t  facility,
     53  const int             event_id,
     54  const log_severity_t  severity,
     55  const void           *buf,
     56  const size_t          len
     57);
     58@end example
     59@end ifset
     60
     61@ifset is-Ada
     62@end ifset
     63
     64@subheading STATUS CODES:
     65
     66@table @b
     67@item EINVAL
     68The facility argument is not a valid log_facility.
     69@item EINVAL
     70The severity argument exceeds {LOG_SEVERITY_MAX}
     71@item EINVAL
     72The len argument exceeds {LOG_ENTRY_MAXLEN}
     73@item ENOSPC
     74The log file has run out of space on the device.
     75@item ENOSYS
     76The function log_write() is not supported by this implementation.
     77@item EPERM
     78The caller does not have appropriate permission for writing to
     79the given facility.
     80@item EIO
     81An I/O error occurred in writing to the system event log.
     82
     83@end table
     84
     85@subheading DESCRIPTION:
     86
     87The @code{log_write} function writes an event record, consisting
     88of event attributes, and the data identified by the @code{buf}
     89argument, to the system log.
     90
     91@subheading NOTES:
     92
     93@page
     94@subsection log_open - Open a log file
    7395
    7496@subheading CALLING SEQUENCE:
     
    7799@example
    78100int log_open(
    79 );
    80 @end example
    81 @end ifset
    82 
    83 @ifset is-Ada
    84 @end ifset
    85 
    86 @subheading STATUS CODES:
    87 
    88 @table @b
    89 @item E
    90 The
    91 
    92 @end table
    93 
    94 @subheading DESCRIPTION:
    95 
    96 @subheading NOTES:
    97 
    98 @page
    99 @subsection log_read -
     101  const logd_t         *logdes,
     102  const char           *path,
     103  const log_query_t    *query
     104);
     105@end example
     106@end ifset
     107
     108@ifset is-Ada
     109@end ifset
     110
     111@subheading STATUS CODES:
     112
     113@table @b
     114@item EACCES
     115Search permission is denied on a component of the path prefix,
     116or the log file exists and read permission is denied.
     117@item  EINTR
     118A signal interrupted the call to log_open().
     119@item EINVAL
     120The log_facility field of the query argument is not a valid
     121facility set.
     122@item EINVAL
     123The log_severity field of the query argument exceeds
     124{LOG_SEVERITY_MAX}.
     125@item EINVAL
     126The path argument referred to a file that was not a log file.
     127@item EMFILE
     128Too many log file descriptors are currently in use by this
     129process.
     130@item ENAMETOOLONG
     131The length of the path string exceeds {PATH_MAX}, or a pathname
     132component is longer than {NAME_MAX} while {_POSIX_NO_TRUNC} is
     133in effect.
     134@item ENFILE
     135Too many files are currently open in the system.
     136@item ENOENT
     137The file specified by the path argument does not exist.
     138@item ENOTDIR
     139A component of the path prefix is not a directory.
     140@item ENOSYS
     141The function log_open() is not supported by this implementation.
     142
     143@end table
     144
     145@subheading DESCRIPTION:
     146
     147The @code{log_open} function establishes the connection between a
     148log file and a log file descriptor.
     149
     150@subheading NOTES:
     151
     152@page
     153@subsection log_read - Read from the system Log
    100154
    101155@subheading CALLING SEQUENCE:
     
    104158@example
    105159int log_read(
    106 );
    107 @end example
    108 @end ifset
    109 
    110 @ifset is-Ada
    111 @end ifset
    112 
    113 @subheading STATUS CODES:
    114 
    115 @table @b
    116 @item E
    117 The
    118 
    119 @end table
    120 
    121 @subheading DESCRIPTION:
    122 
    123 @subheading NOTES:
    124 
    125 @page
    126 @subsection log_notify -
     160  const logd_t logdes,
     161  struct log_entry *entry,
     162  void             *log_buf,
     163  const size_t      log_len,
     164  const size_t     *log_sizeread
     165);
     166@end example
     167@end ifset
     168
     169@ifset is-Ada
     170@end ifset
     171
     172@subheading STATUS CODES:
     173
     174@table @b
     175@item EBADF
     176The logdes argument is not a valid log file descriptor.
     177@item EBUSY
     178No data available.  The open log file descriptor references
     179the current system log.  and there are no unread event records
     180remaining.
     181@item EINTR
     182A signal interrupted the call to log_read().
     183@item ENOSYS
     184The function log_read() is not supported by this implementation.
     185@item EIO
     186An I/O error occurred in reading from the event log.
     187
     188@end table
     189
     190@subheading DESCRIPTION:
     191
     192
     193@subheading NOTES:
     194
     195@page
     196@subsection log_notify - Notify Process of writes to the system log.
    127197
    128198@subheading CALLING SEQUENCE:
     
    131201@example
    132202int log_notify(
    133 );
    134 @end example
    135 @end ifset
    136 
    137 @ifset is-Ada
    138 @end ifset
    139 
    140 @subheading STATUS CODES:
    141 
    142 @table @b
    143 @item E
    144 The
    145 
    146 @end table
    147 
    148 @subheading DESCRIPTION:
    149 
    150 @subheading NOTES:
    151 
    152 @page
    153 @subsection log_close -
     203  const logd_t           logdes,
     204  const struct sigevent *notification
     205);
     206@end example
     207@end ifset
     208
     209@ifset is-Ada
     210@end ifset
     211
     212@subheading STATUS CODES:
     213
     214@table @b
     215@item EBADF
     216The logdes arfument is not a valid log file descriptor.
     217@item EINVAL
     218The notification argument specifies an invalid signal.
     219@item EINVAL
     220The process has requested a notify on a log that will not be
     221written to.
     222@item ENOSY
     223The function log_notify() is not supported by this implementation.
     224
     225@end table
     226
     227@subheading DESCRIPTION:
     228
     229@subheading NOTES:
     230
     231@page
     232@subsection log_close - Close log descriptor
    154233
    155234@subheading CALLING SEQUENCE:
     
    158237@example
    159238int log_close(
    160 );
    161 @end example
    162 @end ifset
    163 
    164 @ifset is-Ada
    165 @end ifset
    166 
    167 @subheading STATUS CODES:
    168 
    169 @table @b
    170 @item E
    171 The
    172 
    173 @end table
    174 
    175 @subheading DESCRIPTION:
    176 
    177 @subheading NOTES:
    178 
    179 @page
    180 @subsection log_seek -
     239  const logd_t   logdes
     240);
     241@end example
     242@end ifset
     243
     244@ifset is-Ada
     245@end ifset
     246
     247@subheading STATUS CODES:
     248
     249@table @b
     250@item EBADF
     251The logdes argument is not a valid log file descriptor.
     252@item ENOSYS
     253The function log_close() is not supported by t his implementation.
     254
     255@end table
     256
     257@subheading DESCRIPTION:
     258
     259The @code{log_close} function deallocates the open log file
     260descriptor indicated by @code{log_des}.
     261
     262@subheading NOTES:
     263
     264@page
     265@subsection log_seek - Reposition log file offset
    181266
    182267@subheading CALLING SEQUENCE:
     
    185270@example
    186271int log_seek(
    187 );
    188 @end example
    189 @end ifset
    190 
    191 @ifset is-Ada
    192 @end ifset
    193 
    194 @subheading STATUS CODES:
    195 
    196 @table @b
    197 @item E
    198 The
    199 
    200 @end table
    201 
    202 @subheading DESCRIPTION:
    203 
    204 @subheading NOTES:
    205 
    206 @page
    207 @subsection log_severity_before -
     272  const logd_t    logdes,
     273  log_recid_t     log_recid
     274);
     275@end example
     276@end ifset
     277
     278@ifset is-Ada
     279@end ifset
     280
     281@subheading STATUS CODES:
     282
     283@table @b
     284@item EBADF
     285The logdes argument is not a valid log file descriptor.
     286@item EINTR
     287The log_seek() function was interrupted by a signal.
     288@item EINVAL
     289The log_recid argument is not a valid record id.
     290@item ENOSYS
     291The function log_seek() is not supported by this implementation.
     292
     293@end table
     294
     295@subheading DESCRIPTION:
     296
     297The @code{log_seek} function shall set the log file offset of the open
     298log descriptioin associated with the @code{logdes} log file descriptor to the
     299event record in the log file identified by @code{log_recid}. 
     300
     301@subheading NOTES:
     302
     303@page
     304@subsection log_severity_before - Compare event record severities
    208305
    209306@subheading CALLING SEQUENCE:
     
    212309@example
    213310int log_severity_before(
    214 );
    215 @end example
    216 @end ifset
    217 
    218 @ifset is-Ada
    219 @end ifset
    220 
    221 @subheading STATUS CODES:
    222 
    223 @table @b
    224 @item E
    225 The
    226 
    227 @end table
    228 
    229 @subheading DESCRIPTION:
    230 
    231 @subheading NOTES:
    232 
    233 @page
    234 @subsection log_facilityemptyset -
     311  log_severity_t  s1,
     312  log_severity_t  s2
     313);
     314@end example
     315@end ifset
     316
     317@ifset is-Ada
     318@end ifset
     319
     320@subheading STATUS CODES:
     321
     322@table @b
     323@item EINVAL
     324The value of either s1 or s2 exceeds {LOG_SEVERITY_MAX}.
     325@item ENOSYS
     326The function log_severity_before() is not supported by this
     327implementation.
     328
     329@end table
     330
     331@subheading DESCRIPTION:
     332
     333The @code{log_severity_before} function shall compare the severity order
     334of the @code{s1} and @code{s2} arguments.
     335
     336@subheading NOTES:
     337
     338@page
     339@subsection log_facilityemptyset - Manipulate log facility sets
    235340
    236341@subheading CALLING SEQUENCE:
     
    239344@example
    240345int log_facilityemptyset(
    241 );
    242 @end example
    243 @end ifset
    244 
    245 @ifset is-Ada
    246 @end ifset
    247 
    248 @subheading STATUS CODES:
    249 
    250 @table @b
    251 @item E
    252 The
    253 
    254 @end table
    255 
    256 @subheading DESCRIPTION:
    257 
    258 @subheading NOTES:
    259 
    260 @page
    261 @subsection log_facilityfillset -
     346  log_facility_set_t  *set
     347);
     348@end example
     349@end ifset
     350
     351@ifset is-Ada
     352@end ifset
     353
     354@subheading STATUS CODES:
     355
     356@table @b
     357@item EINVAL
     358The facilityno argument is not a valid facility.
     359@item ENOSYS
     360The function is not supported by this implementation.
     361
     362@end table
     363
     364@subheading DESCRIPTION:
     365
     366@subheading NOTES:
     367
     368@page
     369@subsection log_facilityfillset - Manipulate log facility sets
    262370
    263371@subheading CALLING SEQUENCE:
     
    266374@example
    267375int log_facilityfillset(
    268 );
    269 @end example
    270 @end ifset
    271 
    272 @ifset is-Ada
    273 @end ifset
    274 
    275 @subheading STATUS CODES:
    276 
    277 @table @b
    278 @item E
    279 The
    280 
    281 @end table
    282 
    283 @subheading DESCRIPTION:
    284 
    285 @subheading NOTES:
    286 
    287 @page
    288 @subsection log_facilityaddset -
     376  log_facility_set_t  *set
     377);
     378@end example
     379@end ifset
     380
     381@ifset is-Ada
     382@end ifset
     383
     384@subheading STATUS CODES:
     385
     386@table @b
     387@item EINVAL
     388The facilityno argument is not a valid facility.
     389@item ENOSYS
     390The function is not supported by this implementation.
     391
     392@end table
     393
     394@subheading DESCRIPTION:
     395
     396@subheading NOTES:
     397
     398@page
     399@subsection log_facilityaddset - Manipulate log facility sets
    289400
    290401@subheading CALLING SEQUENCE:
     
    293404@example
    294405int log_facilityaddset(
    295 );
    296 @end example
    297 @end ifset
    298 
    299 @ifset is-Ada
    300 @end ifset
    301 
    302 @subheading STATUS CODES:
    303 
    304 @table @b
    305 @item E
    306 The
    307 
    308 @end table
    309 
    310 @subheading DESCRIPTION:
    311 
    312 @subheading NOTES:
    313 
    314 @page
    315 @subsection log_facilitydelset -
     406  log_facility_set_t  *set,
     407  log_facility_t      facilityno
     408);
     409@end example
     410@end ifset
     411
     412@ifset is-Ada
     413@end ifset
     414
     415@subheading STATUS CODES:
     416
     417@table @b
     418@item EINVAL
     419The facilityno argument is not a valid facility.
     420@item ENOSYS
     421The function is not supported by this implementation.
     422
     423@end table
     424
     425@subheading DESCRIPTION:
     426
     427@subheading NOTES:
     428
     429@page
     430@subsection log_facilitydelset - Manipulate log facility sets
    316431
    317432@subheading CALLING SEQUENCE:
     
    320435@example
    321436int log_facilitydelset(
    322 );
    323 @end example
    324 @end ifset
    325 
    326 @ifset is-Ada
    327 @end ifset
    328 
    329 @subheading STATUS CODES:
    330 
    331 @table @b
    332 @item E
    333 The
    334 
    335 @end table
    336 
    337 @subheading DESCRIPTION:
    338 
    339 @subheading NOTES:
    340 
    341 @page
    342 @subsection log_facilityismember -
     437  log_facility_set_t  *set,
     438  log_facility_t      facilityno
     439);
     440@end example
     441@end ifset
     442
     443@ifset is-Ada
     444@end ifset
     445
     446@subheading STATUS CODES:
     447
     448@table @b
     449@item EINVAL
     450The facilityno argument is not a valid facility.
     451@item ENOSYS
     452The function is not supported by this implementation.
     453
     454@end table
     455
     456@subheading DESCRIPTION:
     457
     458@subheading NOTES:
     459
     460@page
     461@subsection log_facilityismember - Manipulate log facility sets
    343462
    344463@subheading CALLING SEQUENCE:
     
    347466@example
    348467int log_facilityismember(
    349 );
    350 @end example
    351 @end ifset
    352 
    353 @ifset is-Ada
    354 @end ifset
    355 
    356 @subheading STATUS CODES:
    357 
    358 @table @b
    359 @item E
    360 The
    361 
    362 @end table
    363 
    364 @subheading DESCRIPTION:
    365 
    366 @subheading NOTES:
    367 
     468  const log_facility_set_t *set,
     469  log_facility_t            facilityno,
     470  const int                *member
     471);
     472@end example
     473@end ifset
     474
     475@ifset is-Ada
     476@end ifset
     477
     478@subheading STATUS CODES:
     479
     480@table @b
     481@item EINVAL
     482The facilityno argument is not a valid facility.
     483@item ENOSYS
     484The function is not supported by this implementation.
     485
     486@end table
     487
     488@subheading DESCRIPTION:
     489
     490@subheading NOTES:
     491
Note: See TracChangeset for help on using the changeset viewer.