ACE/ace/Log_Msg_Android_Logcat.h

   1 /**
   2  * @file Log_Msg_Android_Logcat.h
   3  *
   4  * @author Frederick Hornsey <hornseyf@objectcomputing.com>
   5  */
   6
   7 #ifndef ACE_LOG_MSG_ANDROID_LOGCAT_H
   8 #define ACE_LOG_MSG_ANDROID_LOGCAT_H
   9
  10 #include /**/ "ace/pre.h"
  11
  12 #include /**/ "ace/config-all.h"
  13
  14 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  15 # pragma once
  16 #endif /* ACE_LACKS_PRAGMA_ONCE */
  17
  18 #ifdef ACE_ANDROID
  19
  20 #include "ace/Log_Msg_Backend.h"
  21 #include "ace/Basic_Types.h"
  22
  23 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  24
  25 /**
  26  * @class ACE_Log_Msg_Android_Logcat
  27  *
  28  * @brief Implements an ACE_Log_Msg_Backend that logs messages to Android's
  29  * logging system, called Logcat. On Android this is the default output for ACE
  30  * and the only convenient way of logging.
  31  *
  32  * Reference to the Logging part of Android's NDK API can be found here:
  33  * https://developer.android.com/ndk/reference/group/logging
  34  */
  35 class ACE_Export ACE_Log_Msg_Android_Logcat : public ACE_Log_Msg_Backend
  36 {
  37 public:
  38   ACE_Log_Msg_Android_Logcat () = default;
  39   ~ACE_Log_Msg_Android_Logcat () override;
  40
  41   /// Initialize the event logging facility. NOP in this class.
  42   int open (const ACE_TCHAR *) override;
  43
  44   /// Reset the backend. NOP in this class.
  45   int reset () override;
  46
  47   /// Close the backend completely. NOP in this class.
  48   int close () override;
  49
  50   /// This is called when we want to log a message.
  51   ssize_t log (ACE_Log_Record &log_record) override;
  52 };
  53
  54 ACE_END_VERSIONED_NAMESPACE_DECL
  55
  56 #endif
  57
  58 #include /**/ "ace/post.h"
  59 #endif /* ACE_LOG_MSG_ANDROID_LOGCAT */