service/system/logger_service/server/include/readerWriter/reader/reader.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_READER_READER_H_
  23 #define LOGGER_SERVICE_SERVER_INCLUDE_READERWRITER_READER_READER_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 CReader {
  32  public:
  33   CReader();
  34   virtual ~CReader();
  35
  36   static CReader* OpenReader(CLoggerCfg* f_pLoggerCfg, EReaderType f_type,
  37                              std::string f_name, UI_32 f_maxSize);
  38   virtual EFrameworkunifiedStatus Initialize(CLoggerCfg* f_pLoggerCfg, std::string f_name,
  39                                 UI_32 f_maxSize) = 0;
  40   virtual BOOL IsOpen(void) = 0;
  41   virtual EFrameworkunifiedStatus Open(void) = 0;
  42   virtual EFrameworkunifiedStatus Read(UI_8* f_data, UI_32 f_length, SI_32& f_bytesRead) = 0;  // NOLINT (runtime/references)
  43   virtual EFrameworkunifiedStatus ReadToFile(std::string f_fileName, UI_32& f_Written);  // NOLINT (runtime/references)
  44
  45   virtual void Close() = 0;
  46   virtual EFrameworkunifiedStatus ResetPosition(void);
  47
  48  protected:
  49   CLoggerCfg * m_pLoggerCfg;
  50 };
  51 }  // namespace ReaderWriter
  52 #endif  // LOGGER_SERVICE_SERVER_INCLUDE_READERWRITER_READER_READER_H_