service/system/logger_service/server/include/readerWriter/writer/writer.h

   1 /*
   2  * @copyright Copyright (c) 2016-2020 TOYOTA MOTOR CORPORATION.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 ///////////////////////////////////////////////////////////////////////////////
  18 /// \ingroup  tag_SS_LoggerService
  19 /// \brief    TODO
  20 ///
  21 ///////////////////////////////////////////////////////////////////////////////
  22 #ifndef LOGGER_SERVICE_SERVER_INCLUDE_READERWRITER_WRITER_WRITER_H_
  23 #define LOGGER_SERVICE_SERVER_INCLUDE_READERWRITER_WRITER_WRITER_H_
  24 #include <native_service/frameworkunified_types.h>
  25 #include <string>
  26 #include "readerWriter/reader_writer_cfg.h"
  27 #include "ss_logger_cfg.h"
  28
  29 namespace ReaderWriter {
  30
  31 class CWriter {
  32  public:
  33   CWriter();
  34   virtual ~CWriter();
  35
  36   static CWriter* OpenWriter(CLoggerCfg* f_pLoggerCfg, EReaderType f_type,
  37                              std::string f_Name1, UI_32 f_size1,
  38                              std::string f_Name2, UI_32 f_size2);
  39   virtual EFrameworkunifiedStatus Initialize(CLoggerCfg* f_pLoggerCfg, std::string f_Name1,
  40                                 UI_32 f_size1, std::string f_Name2,
  41                                 UI_32 f_size2) = 0;
  42   virtual EFrameworkunifiedStatus Write(UI_8 *f_data, UI_32 f_length,
  43                            SI_32 &f_bytesWritten) = 0;  // NOLINT (runtime/references)
  44   virtual void Close() = 0;
  45   virtual EFrameworkunifiedStatus FlushCache(void);
  46   virtual EFrameworkunifiedStatus UpdateLoggingParameters(void);
  47   virtual BOOL IsOpen(void) = 0;
  48   virtual EFrameworkunifiedStatus Open(void) = 0;
  49
  50  protected:
  51   CLoggerCfg * m_pLoggerCfg;
  52 };
  53
  54 }  // namespace ReaderWriter
  55
  56 #endif  // LOGGER_SERVICE_SERVER_INCLUDE_READERWRITER_WRITER_WRITER_H_