home *** CD-ROM | disk | FTP | other *** search
/ MACD 5 / MACD5.iso / workbench / monitory / syslog_v1.00 / developer / syslog.autodoc
Encoding:
Text File  |  1995-11-13  |  4.0 KB  |  137 lines
  1. TABLE OF CONTENTS
  2.  
  3. syslog.library/--background--
  4. syslog.library/Log
  5. syslog.library/DeleteSysLogMessage
  6. syslog.library/GetSysLogMsgTime
  7. syslog.library/AddSysLogSpy
  8. syslog.library/RemSysLogSpy
  9. syslog.library/Log                                syslog.library/Log
  10.  
  11.   NAME
  12.     Log - Log a message
  13.  
  14.   SYNOPSIS
  15.     Log( pri, options, tag, message, argarray )
  16.          D0   D1       A0   A1       A2
  17.  
  18.     void Log( LONG pri, LONG options, UBYTE *tag, UBYTE *message, LONG *argarray );
  19.  
  20.   FUNCTION
  21.     This routine sends a message to all spies connected to syslog.library.
  22.     The message is constructed from tag, message and arguments. This
  23.     routine is safe to be called from interrupts as long as LOG_PID,
  24.     LOG_PERROR and LOG_CONS options are not used. LOG_PERROR and LOG_CONS
  25.     options can not be used when this routine is called by a task.
  26.  
  27.     If LOG_PID option is used, the current task's process number, or if
  28.     Executive is present, task's PID is included in the message.
  29.  
  30.     LOG_PERROR and LOG_CONS output the message to current error stream
  31.     and to current console. If processes's pr_CES is NULL, pr_COS is
  32.     used.
  33.  
  34.     Maximum length including time is 1024 characters.
  35.  
  36.   INPUTS
  37.     pri - facility and priority
  38.     options - miscellaneous options
  39.     tag - tag the message with this string
  40.     message - message to log
  41.     argarray - pointer to array of arguments
  42.  
  43.   SEE ALSO
  44.     <libraries/syslog.h>
  45. syslog.library/DeleteSysLogMessage                syslog.library/DeleteSysLogMessage
  46.  
  47.   NAME
  48.     DeleteSysLogMessage - Delete a message generated by syslog.library
  49.  
  50.   SYNOPSIS
  51.     DeleteSysLogMessage( message )
  52.                          A0
  53.  
  54.     void DeleteSysLogMessage( struct SysLogMessage *message );
  55.  
  56.   FUNCTION
  57.     When a SPY has processed a message it has received from syslog.library,
  58.     it must call this routine. The message is deleted and memory deallocated.
  59.  
  60.   INPUTS
  61.     message - message received from syslog.library
  62.  
  63.   SEE ALSO
  64.     <libraries/syslog.h>, AddSysLogSpy(), RemSysLogSpy()
  65. syslog.library/GetSysLogMsgTime                   syslog.library/GetSysLogMsgTime
  66.  
  67.   NAME
  68.     GetSysLogMsgTime - Put a time stamp to SysLog message
  69.  
  70.   SYNOPSIS
  71.     GetSysLogMsgTime( message )
  72.                       A0
  73.  
  74.     void GetSysLogMsgTime( struct SysLogMessage *message );
  75.  
  76.   FUNCTION
  77.     When a message is received from syslog.library, this routine must
  78.     be called. A time stamp will be written to the message. There are
  79.     some good reasons why Log()-function can't easily/quickly obtain
  80.     the current system time, especially if it's called from interrupt.
  81.     Even if you would call this function long time after the message
  82.     was generated, the time will still be correct.
  83.  
  84.   INPUTS
  85.     message - message received from syslog.library
  86.  
  87.   SEE ALSO
  88.     <libraries/syslog.h>, AddSysLogSpy(), RemSysLogSpy()
  89. syslog.library/AddSysLogSpy                       syslog.library/AddSysLogSpy
  90.  
  91.   NAME
  92.     AddSysLogSpy - Add a spy to syslog.library
  93.  
  94.   SYNOPSIS
  95.     SysLogSpy = AddSysLogSpy()
  96.     D0
  97.  
  98.     struct SysLogSpy *AddSysLogSpy( void );
  99.  
  100.   FUNCTION
  101.     If you want to listen to log messages, you can add a spy to
  102.     syslog.library. This routine returns an initialized SysLogSpy
  103.     structure. Messages will be sent to Spy_port, found in the
  104.     returned structure.
  105.  
  106.     When this function returns, there may already be a message in
  107.     the Spy_port.
  108.  
  109.   INPUTS
  110.     None
  111.  
  112.   RESULT
  113.     Initialized SysLogSpy structure, NULL if error
  114.  
  115.   SEE ALSO
  116.     <libraries/syslog.h>, RemSysLogSpy(), DeleteSysLogMessage(), GetSysLogMsgTime()
  117. syslog.library/RemSysLogSpy                       syslog.library/RemSysLogSpy
  118.  
  119.   NAME
  120.     RemSysLogSpy - Remove a spy from syslog.library
  121.  
  122.   SYNOPSIS
  123.     RemSysLogSpy( spy )
  124.  
  125.     RemSysLogSpy( struct SysLogSpy * );
  126.                   A0
  127.  
  128.   FUNCTION
  129.     A spy added using AddSysLogSpy() must be removed with this
  130.     function. Messages still in the Spy_port will be safely deallocated.
  131.  
  132.   INPUTS
  133.     spy - SysLogSpy structure returned by AddSysLogSpy()
  134.  
  135.   SEE ALSO
  136.     <libraries/syslog.h>, AddSysLogSpy(), DeleteSysLogMessage(), GetSysLogMsgTime()
  137.