Changeset 2dd561a3 in rtems


Ignore:
Timestamp:
Aug 11, 1998, 10:10:51 PM (21 years ago)
Author:
Wade A Smith <warm38@…>
Branches:
4.10, 4.11, 4.8, 4.9, master
Children:
c40ad43
Parents:
09470e0
Message:

Updated the description section for the following routines:

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

    r09470e0 r2dd561a3  
    330330   replace the existing notification registration.
    331331
     332   If the @code{notification} argument is NULL and the calling process is
     333   currently registered to be notified for the @code{logdes} log file
     334   descriptor, the existing registration shall be removed.
     335
    332336Otherwise:
    333337
     
    365369@subheading DESCRIPTION:
    366370
    367 The @code{log_close} function deallocates the open log file
    368 descriptor indicated by @code{log_des}.
     371If {_POSIX_LOGGING} is defined:
     372
     373   The @code{log_close} function deallocates the open log file descriptor
     374   indicated by @code{log_des}.
     375
     376   When all log file descriptors associated with an open log file description
     377   have been closed, the open log file description shall be freed.
     378
     379   If the link count of the log file is zero, when all log file descriptors
     380   have been closed, the space occupied by the log file shall be freed and the
     381   log file shall no longer be accessible.
     382
     383   If the process has successfully registered a notification request for the
     384   log file descriptor, the registration shall be removed.
     385
     386Otherwise:
     387
     388   The @code{log_close} function shall fail.
    369389
    370390@subheading NOTES:
     
    403423@subheading DESCRIPTION:
    404424
    405 The @code{log_seek} function shall set the log file offset of the open
    406 log descriptioin associated with the @code{logdes} log file descriptor to the
    407 event record in the log file identified by @code{log_recid}. 
     425If {_POSIX_LOGGING} is defined:
     426
     427   The @code{log_seek} function shall set the log file offset of the open
     428   log descriptioin associated with the @code{logdes} log file descriptor
     429   to the event record in the log file identified by @code{log_recid}. 
     430   The @code{log_recid} argument is either the record id of a valid event
     431   record or one of the following values, as defined in the header <evlog.h>:
     432      LOG_SEEK_START - Set log file position to point at the first event
     433                       record in the log file
     434      LOG_SEEK_END   - Set log file position to point after the last event
     435                       record in the log file
     436   If the @code{log_seek} function is interrupted, the state of the open log
     437   file description associated with @code{logdes} is unspecified.
     438
     439Otherwise:
     440
     441   The @code{log_seek} function shall fail.
    408442
    409443@subheading NOTES:
     
    439473@subheading DESCRIPTION:
    440474
    441 The @code{log_severity_before} function shall compare the severity order
    442 of the @code{s1} and @code{s2} arguments.
     475If {_POSIX_LOGGING} is defined:
     476
     477   The @code{log_severity_before} function shall compare the severity order
     478   of the @code{s1} and @code{s2} arguments.  Severity values ordered
     479   according to this function shall be according to decreasing severity.
     480
     481   If @code{s1} is ordered before or is equal to @code{s2} then the ordering
     482   predicate shall return 1, otherwise the predicate shall return 0.  If
     483   either @code{s1} or @code{s2} specify invlid severity values, the return
     484   value of @code{log_severity_before} is unspecified.
     485
     486Otherwise:
     487   
     488   The @code{log_severity_before} function shall fail.
    443489
    444490@subheading NOTES:
     
    472518@subheading DESCRIPTION:
    473519
     520If {_POSIX_LOGGING} is defined:
     521
     522   The facilitysetops primitives manipulate sets of facilities.  They
     523   operate on data objects addressable by the application.
     524
     525   The @code{log_facilityemptyset} function initializes the facility
     526   set pointed to by the argument @code{set}, such that all facilties
     527   are included.
     528
     529   Applications shall call either @code{log_facilityemptyset} or
     530   @code{log_cacilityfillset} at least once for each object of type
     531   @code{log_facilityset_t} prior to any other use of that object.  If
     532   such an object is not initialized in this way, but is nonetheless
     533   supplied as an argument  to any of the @code{log_facilityaddset},
     534   @code{logfacilitydelset}, @code{log_facilityismember} or
     535   @code{log_open} functions, the results are undefined.
     536
     537   The @code{log_facilityaddset} and @code{log_facilitydelset} functions
     538   respectively add or delete the individual facility specified by the
     539   value of the argument @code{facilityno} to or from the facility set
     540   pointed to by the argument @code{set}
     541
     542   The @code{log_facilityismember} function tests whether the facility
     543   specified by the value of the argument @code{facilityno} is a member
     544   of the set pointed to by the argument @code{set}.  Upon successful
     545   completion, the @code{log_facilityismember} function either returns
     546   a value of one to the location specified by @code{member} if the
     547   specified facility is a member of the specified set or returns a
     548   value of zero to the location specified by @code{member} if the
     549   specified facility is not a member of the specified set.
     550
     551Otherwise:
     552
     553   The function fails
     554
    474555@subheading NOTES:
    475556
     
    501582
    502583@subheading DESCRIPTION:
     584
     585If {_POSIX_LOGGING} is defined:
     586
     587   The facilitysetops primitives manipulate sets of facilities.  They
     588   operate on data objects addressable by the application.
     589
     590   The @code{log_facilityemptyset} function initializes the facility
     591   set pointed to by the argument @code{set}, such that all facilties
     592   are included.
     593
     594   Applications shall call either @code{log_facilityemptyset} or
     595   @code{log_cacilityfillset} at least once for each object of type
     596   @code{log_facilityset_t} prior to any other use of that object.  If
     597   such an object is not initialized in this way, but is nonetheless
     598   supplied as an argument  to any of the @code{log_facilityaddset},
     599   @code{logfacilitydelset}, @code{log_facilityismember} or
     600   @code{log_open} functions, the results are undefined.
     601
     602   The @code{log_facilityaddset} and @code{log_facilitydelset} functions
     603   respectively add or delete the individual facility specified by the
     604   value of the argument @code{facilityno} to or from the facility set
     605   pointed to by the argument @code{set}
     606
     607   The @code{log_facilityismember} function tests whether the facility
     608   specified by the value of the argument @code{facilityno} is a member
     609   of the set pointed to by the argument @code{set}.  Upon successful
     610   completion, the @code{log_facilityismember} function either returns
     611   a value of one to the location specified by @code{member} if the
     612   specified facility is a member of the specified set or returns a
     613   value of zero to the location specified by @code{member} if the
     614   specified facility is not a member of the specified set.
     615
     616Otherwise:
     617
     618   The function fails
    503619
    504620@subheading NOTES:
     
    533649@subheading DESCRIPTION:
    534650
     651If {_POSIX_LOGGING} is defined:
     652
     653   The facilitysetops primitives manipulate sets of facilities.  They
     654   operate on data objects addressable by the application.
     655
     656   The @code{log_facilityemptyset} function initializes the facility
     657   set pointed to by the argument @code{set}, such that all facilties
     658   are included.
     659
     660   Applications shall call either @code{log_facilityemptyset} or
     661   @code{log_cacilityfillset} at least once for each object of type
     662   @code{log_facilityset_t} prior to any other use of that object.  If
     663   such an object is not initialized in this way, but is nonetheless
     664   supplied as an argument  to any of the @code{log_facilityaddset},
     665   @code{logfacilitydelset}, @code{log_facilityismember} or
     666   @code{log_open} functions, the results are undefined.
     667
     668   The @code{log_facilityaddset} and @code{log_facilitydelset} functions
     669   respectively add or delete the individual facility specified by the
     670   value of the argument @code{facilityno} to or from the facility set
     671   pointed to by the argument @code{set}
     672
     673   The @code{log_facilityismember} function tests whether the facility
     674   specified by the value of the argument @code{facilityno} is a member
     675   of the set pointed to by the argument @code{set}.  Upon successful
     676   completion, the @code{log_facilityismember} function either returns
     677   a value of one to the location specified by @code{member} if the
     678   specified facility is a member of the specified set or returns a
     679   value of zero to the location specified by @code{member} if the
     680   specified facility is not a member of the specified set.
     681
     682Otherwise:
     683
     684   The function fails
     685
    535686@subheading NOTES:
    536687
     
    563714
    564715@subheading DESCRIPTION:
     716
     717If {_POSIX_LOGGING} is defined:
     718
     719   The facilitysetops primitives manipulate sets of facilities.  They
     720   operate on data objects addressable by the application.
     721
     722   The @code{log_facilityemptyset} function initializes the facility
     723   set pointed to by the argument @code{set}, such that all facilties
     724   are included.
     725
     726   Applications shall call either @code{log_facilityemptyset} or
     727   @code{log_cacilityfillset} at least once for each object of type
     728   @code{log_facilityset_t} prior to any other use of that object.  If
     729   such an object is not initialized in this way, but is nonetheless
     730   supplied as an argument  to any of the @code{log_facilityaddset},
     731   @code{logfacilitydelset}, @code{log_facilityismember} or
     732   @code{log_open} functions, the results are undefined.
     733
     734   The @code{log_facilityaddset} and @code{log_facilitydelset} functions
     735   respectively add or delete the individual facility specified by the
     736   value of the argument @code{facilityno} to or from the facility set
     737   pointed to by the argument @code{set}
     738
     739   The @code{log_facilityismember} function tests whether the facility
     740   specified by the value of the argument @code{facilityno} is a member
     741   of the set pointed to by the argument @code{set}.  Upon successful
     742   completion, the @code{log_facilityismember} function either returns
     743   a value of one to the location specified by @code{member} if the
     744   specified facility is a member of the specified set or returns a
     745   value of zero to the location specified by @code{member} if the
     746   specified facility is not a member of the specified set.
     747
     748Otherwise:
     749
     750   The function fails
    565751
    566752@subheading NOTES:
     
    596782@subheading DESCRIPTION:
    597783
    598 @subheading NOTES:
    599 
     784If {_POSIX_LOGGING} is defined:
     785
     786   The facilitysetops primitives manipulate sets of facilities.  They
     787   operate on data objects addressable by the application.
     788
     789   The @code{log_facilityemptyset} function initializes the facility
     790   set pointed to by the argument @code{set}, such that all facilties
     791   are included.
     792
     793   Applications shall call either @code{log_facilityemptyset} or
     794   @code{log_cacilityfillset} at least once for each object of type
     795   @code{log_facilityset_t} prior to any other use of that object.  If
     796   such an object is not initialized in this way, but is nonetheless
     797   supplied as an argument  to any of the @code{log_facilityaddset},
     798   @code{logfacilitydelset}, @code{log_facilityismember} or
     799   @code{log_open} functions, the results are undefined.
     800
     801   The @code{log_facilityaddset} and @code{log_facilitydelset} functions
     802   respectively add or delete the individual facility specified by the
     803   value of the argument @code{facilityno} to or from the facility set
     804   pointed to by the argument @code{set}
     805
     806   The @code{log_facilityismember} function tests whether the facility
     807   specified by the value of the argument @code{facilityno} is a member
     808   of the set pointed to by the argument @code{set}.  Upon successful
     809   completion, the @code{log_facilityismember} function either returns
     810   a value of one to the location specified by @code{member} if the
     811   specified facility is a member of the specified set or returns a
     812   value of zero to the location specified by @code{member} if the
     813   specified facility is not a member of the specified set.
     814
     815Otherwise:
     816
     817   The function fails
     818
     819@subheading NOTES:
     820
Note: See TracChangeset for help on using the changeset viewer.