Changeset 09470e0 in rtems


Ignore:
Timestamp:
Aug 11, 1998, 8:38:09 PM (21 years ago)
Author:
Wade A Smith <warm38@…>
Branches:
4.10, 4.11, 4.8, 4.9, master
Children:
2dd561a3
Parents:
7d07970
Message:

Updated the Description section for the following routines:

log_notify, log_read, log_open, and log_write.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/new_chapters/eventlog.t

    r7d07970 r09470e0  
    180180@subheading DESCRIPTION:
    181181
    182 The @code{log_open} function establishes the connection between a
    183 log file and a log file descriptor.
     182If {_POSIX_LOGGING} is defined:
     183
     184   The @code{log_open} function establishes the connection between a
     185   log file and a log file descriptor.  It creates an open log file
     186   description that refers to a log file and a log file descriptor that
     187   refers to that open log file description.  The log file descriptor is
     188   used by other log functions to refer to that log file.  The @code{path}
     189   argument points to a pathname naming a log file.  A @code{path}
     190   argument of NULL specifies the current system log file. 
     191
     192   The @code{query} argument points to a log query specification that
     193   restricts log operations using the returned log file descriptor to
     194   to event records from the log file which match the query.  The
     195   predicate which determines the success of the match operation is the
     196   logical AND of the individual comparison predicates for each member
     197   of the log query specification.  The query attribute of the open file
     198   description is set to filter as specified by the @code{query} argument.
     199   If the value of the query argument is not NULL, the value of the
     200   @code{log_facility} member of the @code{query} specification shall be
     201   a set of valid log facilities or the @code{log_open} shall fail.  If
     202   the value of the @code{query} argument is not NULL, the value of the
     203   @code{log_severity} member of the @code{query} specification shall be
     204   less than or equal to @code{LOG_SEVERITY_MAX} or the @code{log_open}
     205   shall fail.  If the value of the @code{query} argument is NULL, no
     206   query filter shall be applied.
     207
     208Otherwise:
     209
     210   The @code{log_open} shall fail.
    184211
    185212@subheading NOTES:
     
    225252@subheading DESCRIPTION:
    226253
     254If {_POSIX_LOGGING} is defined:
     255
     256   The @code{log_read} function shall attempt to read the @code{log_entry}
     257   structure and @code{log_len} bytes of data from the next event record
     258   of the log file associated with the open log file descriptor @code{logdes},
     259   placing the @code{log_entry} structure into the buffer pointed to by
     260   @code{entry}, and the data into the buffer pointed to by @code{log_buf}.
     261   The log record ID of the returned event record shall be stored in the
     262   @code{log_recied} member of the @code{log_entry} structure for the event
     263   record.
     264
     265   If the query attribute of the open log file description associated with
     266   the @code{logdes} is set, the event record read shall match that query.
     267   If the @code{entry} argument is not NULL it will point to a @code{log_entry}
     268   structure which sall be filled with the creation information for this log
     269   entry.  If the argument @code{log_buf} is not NULL the data written with the
     270   log entry will be placed in the buffer.  The size of the buffer is specified
     271   by the argument @code{log_len}.
     272
     273   If the @code{log_read} is successful the call shall store the actual length
     274   of the data associated with the event record into the location specified by
     275   @code{log_sizeread}.  This number may be smaller or greater than
     276   @code{log_len}.
     277
     278Otherwise:
     279
     280   The @code{log_read} function shall fail.
     281
    227282
    228283@subheading NOTES:
     
    262317@subheading DESCRIPTION:
    263318
     319If {_POSIX_LOGGING} is defined:
     320 
     321   If the argument @code{notification} is not NULL this function registers
     322   the calling process to be notified of event records received by the system
     323   log, which match the query parameters associated with the open log descriptor
     324   specified by @code{logdes}.  The notification specified by the
     325   @code{notification} argument shall be sent to the process when an event
     326   record received by the system log is matched by the query attribute of the
     327   open log file description associated with the @code{logdes} log file
     328   descriptor.  If the calling process has already registered a notification
     329   for the @code{logdes} log file descriptor, the new notification shall
     330   replace the existing notification registration.
     331
     332Otherwise:
     333
     334   The @code{log_notify} function shall fail.
     335   
     336
    264337@subheading NOTES:
    265338
Note: See TracChangeset for help on using the changeset viewer.