Changeset b67f7946 in rtems


Ignore:
Timestamp:
Aug 28, 1998, 2:32:01 PM (21 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, 4.8, 4.9, master
Children:
566669f5
Parents:
61b1b37c
Message:

Added log_write_any and part of log_copy.

Reviewed log_close.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/new_chapters/eventlog.t

    r61b1b37c rb67f7946  
    2121@itemize @bullet
    2222@item @code{log_write} - Write to the Log
     23@item @code{log_write_any} - Write to any log file
    2324@item @code{log_open} - Open a log file
    2425@item @code{log_read} - Read from the system Log
    2526@item @code{log_notify} - Notify Process of writes to the system log
    2627@item @code{log_close} - Close log descriptor
     28@item @code{log_copy} -
    2729@item @code{log_seek} - Reposition log file offset
    2830@item @code{log_severity_before} - Compare event record severities
     
    125127of event attributes, and the data identified by the @code{buf}
    126128argument, to the system log.  The @code{len} argument specifies
     129the length in bytes of the buffer pointed to by @code{buf}.  The
     130@code{len} argument shall specify the value of the event record
     131length attribute.  The value of @code{len} shall be less than or
     132equal to @code{LOG_ENTRY_MAXLEN} or the @code{log_write} shall fail.
     133
     134The @code{event_id} argument identifies the type of event record
     135being written.  The @code{event_id} argument shall specify the value
     136of the event ID attribute of the event record.
     137
     138The argument @code{facility} indicates the facility from which the
     139event type is drawn.  The @code{facility} argument shall specify the
     140value of the event record facility attribute.  The value of the
     141@code{facility} argument shall be a valid log facility or the
     142@code{log_write} function shall fail.
     143
     144The @code{severity} argument indicates the severity level of the
     145event record.  The @code{severity} argument shall specify the value
     146of the event record severity attribute.  The value of the
     147@code{severity} argument shall be less than or equal to
     148@code{LOG_SEVERITY_MAX} or the @code{log_write} function shall fail. 
     149
     150The effective_UID of the calling process shall specify the event
     151record UID attribute.  The effective-GID of the calling process
     152shall specify the event record GID attribute.  The process ID
     153of the calling process shall specify the event record process ID
     154attribute.  The process group ID of the calling process shall
     155specify the event record process group ID attribute.  The current
     156value of the system clock shall specify the event record timestamp
     157attribute.
     158
     159@subheading NOTES:
     160
     161The @code{_POSIX_LOGGING} feature flag is defined to indicate
     162this service is available.
     163
     164@page
     165@subsection log_write_any - Write to the any log file
     166
     167@subheading CALLING SEQUENCE:
     168
     169@ifset is-C
     170@example
     171#include <evlog.h>
     172
     173int log_write_any(
     174  const logd_t          logdes,
     175  const log_facility_t  facility,
     176  const int             event_id,
     177  const log_severity_t  severity,
     178  const void           *buf,
     179  const size_t          len
     180);
     181@end example
     182@end ifset
     183 
     184@ifset is-Ada
     185@end ifset
     186
     187@subheading STATUS CODES:
     188
     189@table @b
     190@item EINVAL
     191The facility argument is not a valid log_facility.
     192
     193@item EINVAL
     194The severity argument exceeds @code{LOG_SEVERITY_MAX}
     195
     196@item EINVAL
     197The len argument exceeds @code{LOG_ENTRY_MAXLEN}
     198
     199@item ENOSPC
     200The log file has run out of space on the device.
     201
     202@item EPERM
     203The caller does not have appropriate permission for writing to
     204the given facility.
     205
     206@item EIO
     207An I/O error occurred in writing to the system event log.
     208
     209@end table
     210
     211@subheading DESCRIPTION:
     212
     213The @code{log_write} function writes an event record, consisting
     214of event attributes, and the data identified by the @code{buf}
     215argument, to a log file.  The @code{len} argument specifies
    127216the length in bytes of the buffer pointed to by @code{buf}.  The
    128217@code{len} argument shall specify the value of the event record
     
    416505
    417506When all log file descriptors associated with an open log file description
    418 have been closed, the open log file description shall be freed.
     507have been closed, the open log file description is freed.
    419508
    420509If the link count of the log file is zero, when all log file descriptors
    421 have been closed, the space occupied by the log file shall be freed and the
     510have been closed, the space occupied by the log file is freed and the
    422511log file shall no longer be accessible.
    423512
    424513If the process has successfully registered a notification request for the
    425 log file descriptor, the registration shall be removed.
     514log file descriptor, the registration is removed.
    426515
    427516@subheading NOTES:
Note: See TracChangeset for help on using the changeset viewer.