Developer

API Reference

AEELogParamType

Brew Release
Brew MP 1.0.2
See Also
specific implementation header files for more information.
Description
Possible parameters available to configure the ILogger interface or to get information concerning the current state of the ILogger interface.
In addition to the list below, there may be OEM specific log parameters which will numerically start after AEE_LOG_PARAM_LAST. See the specific implementation header files for more information.
Definition
typedef  uint16                        AEELogParamType;
#define  AEE_LOG_PARAM_INSTANCE_ID     0x001 // InstanceID is a developer-defined ID number 
                                             // that can be used as the developer wishes.  
                                             // Possible uses are to distinguish between 
                                             // different application threads or different 
                                             // application runtime states. The default instance
                                             // ID is zero.
#define  AEE_LOG_PARAM_FILTER_ONE      0x002 // Filter a single log bucket
#define  AEE_LOG_PARAM_FILTER_BLOCK    0x003 // sets filters for a block of 32 buckets
#define  AEE_LOG_PARAM_SENT            0x004 // Number of packets sent by an instance of ILogger
#define  AEE_LOG_PARAM_DROPPED         0x005 // Number of packets dropped by an instance of ILogger
                                             // Dropeed packets do not include packets that have
                                             // been filtered.
#define  AEE_LOG_PARAM_FILE_FLUSH      0x006 // Flushes the current log file and resets file pointer
                                             // to beginning of file.  May only be used 
                                             // with AEECLSID_LOGGER_FILE
#define  AEE_LOG_PARAM_FILE_MAX_SIZE   0x007 // Sets the maximum size the log file may become
                                             // Defaults to 1/2 the free EFS space.
                                             // May only be used with AEECLSID_LOGGER_FILE
#define  AEE_LOG_PARAM_FILE_FREE_SPACE 0x008 // Amount of free space left in the log file
                                             // before it reaches the maximum size set with
                                             // the AEE_LOG_PARAM_FILE_MAX_SIZE parameter
                                             // May only be used with AEECLSID_LOGGER_FILE
#define  AEE_LOG_PARAM_FILE_NEW        0x009 // Closes the current log file and creates 
                                             // a new one using the specified name
                                             // May only be used with AEECLSID_LOGGER_FILE
#define  AEE_LOG_PARAM_SIO_PORT_CONFIG 0x00A // Gets and sets the serial port configuration
                                             // May only be used with AEECLSID_LOGGER_SERIAL
#define  AEE_LOG_PARAM_SIO_OPEN_PORT   0x00B // Opens the serial port for logging, this may
                                             // or may not open the port immediatly, the serial 
                                             // port status is returned by ILOGGER_SetParam() and
                                             // if the port open is in progress the caller must
                                             // check the port status at a later time using
                                             // AEE_LOG_PARAM_SIO_PORT_STATUS or providing
                                             // a callback
                                             // May only be used with AEECLSID_LOGGER_SERIAL
#define  AEE_LOG_PARAM_SIO_CLOSE_PORT  0x00C // Closes the serial port used for logging, this may
                                             // May only be used with AEECLSID_LOGGER_SERIAL
#define  AEE_LOG_PARAM_SIO_PORT_STATUS 0x00D // Returns the status of the serial port
                                             // May only be used with AEECLSID_LOGGER_SERIAL 
#define  AEE_LOG_PARAM_SIO_SET_TRIG    0x00E // Sets serial input/output triggers
                                             // May only be used with AEECLSID_LOGGER_SERIAL
#define  AEE_LOG_PARAM_LAST            0x100 // This must be the last defined param type
                                             // OEM specific parameters start at this value, 
                                             // See the specific implementation header files 
                                             // for more information.
Comment

The following tables describes the parameter usage:
   AEE_LOG_PARAM_INSTANCE_ID
      SetParam:  param  - New instance ID, 
                 pParam - None  
      GetParam:  pParam - Address of memory location to place current instance ID
   AEE_LOG_PARAM_FILTER_ONE
      SetParam:  param  - Log bucket to filter, must be greater then 0 and less then AEE_LOG_BUCKET_LAST
                 pParam - Boolean value indicating weather to turn bucket on or off, TRUE turns bucket on
                          All buckets are off by default
      GetParam:  pParam - None   
   AEE_LOG_PARAM_FILTER_BLOCK
      SetParam:  param  - Which block of filters to set where 0 is the first block and param 
                          must be less then AEE_LOG_NUM_BUCKET_BLOCKS
                 pParam - 32 bit value to set block to.  Each bit represents one bucket
      GetParam:  pParam - When calling which block to get where 0 is the first block, on return the requsted 32 bit block  
   AEE_LOG_PARAM_SENT
      SetParam:  param  - Number to preset sent count with, or zero to reset count, 
                 pParam - None  
      GetParam:  pParam - Address of memory location to place current number of packets sent
   AEE_LOG_PARAM_DROPPED
      SetParam:  param  - Number to preset dropped count with, or zero to reset count, 
                 pParam - None  
      GetParam:  pParam - Address of memory location to place current number of packets dropped
   AEE_LOG_PARAM_FILE_FLUSH
      SetParam:  param  - None 
                 pParam - None  
      GetParam:  Not supported
   AEE_LOG_PARAM_FILE_MAX_SIZE
      SetParam:  param  - New maximum log file size, 
                 pParam - none  
      GetParam:  pParam - address of memory location to place current maximum log file size
   AEE_LOG_PARAM_FILE_FREE_SPACE
      SetParam:  Not supported  
      GetParam:  pParam - address of memory location to place remaining free space in log file
   AEE_LOG_PARAM_FILE_NEW
      SetParam:  param  - File mode: _OFM_READWRITE or_OFM_APPEND, 
                 pParam - string containing name of new log file 
      GetParam:  Not supported
   AEE_LOG_PARAM_SIO_PORT_CONFIG
      SetParam:  param  - None
                 pParam - Pointer to user filled structure of type AEESIOConfig
      GetParam:  param  - None
                 pParam - Pointer to empty structure of type AEESIOConfig to be filled by ILogger
    AEE_LOG_PARAM_SIO_OPEN_PORT
      SetParam:  param  - Optional user callback that will be called when port is opened
                 pParam - Pointer to string that describes which port to open, see AEESio.h
      GetParam:  Not supported
    AEE_LOG_PARAM_SIO_CLOSE_PORT
      SetParam:  param  - None
                 pParam - None
      GetParam:  Not supported
    AEE_LOG_PARAM_SIO_PORT_STATUS
      SetParam:  Not supported
      GetParam:  pParam - address of memory location to place current port status
   AEE_LOG_PARAM_SIO_SET_TRIG
      SetParam:  param  - None
                 pParam - Pointer to user filled structure of type AEESIOTriggers
      GetParam:  Not supported

  *AEE_LOG_PARAM_FILE_NEW must be used to create new file but any other file management
  must be done by the developer using IFILEMGR and IFILE.

  *When using AEECLSID_LOGGER_SERIAL all serial port handling is done by ILogger
   Refer to the ISerialPort interface documentaion for more information about
   serial triggers (AEESIOTriggers) and serial port configuration (AEESIOConfig).
  • Follow