CAN-binder/low-can-binding/diagnostic/active-diagnostic-request.cpp

   1 /*
   2  * Copyright (C) 2015, 2016 "IoT.bzh"
   3  * Author "Romain Forlot" <romain.forlot@iot.bzh>
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *       http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #include <map>
  19 #include <fnmatch.h>
  20
  21 #include "active-diagnostic-request.hpp"
  22
  23 #include "../binding/configuration.hpp"
  24
  25 #define ERROR_PID 0xFF
  26
  27 std::string active_diagnostic_request_t::prefix_ = "diagnostic_messages";
  28
  29 bool active_diagnostic_request_t::operator==(const active_diagnostic_request_t& b)
  30 {
  31         return (bus_ == b.bus_ && id_ == b.id_ && handle_ == b.handle_);
  32 }
  33
  34 active_diagnostic_request_t& active_diagnostic_request_t::operator=(const active_diagnostic_request_t& adr)
  35 {
  36         if (this != &adr)
  37         {
  38                 bus_ = adr.bus_;
  39                 id_ = adr.id_;
  40                 handle_ = adr.handle_;
  41                 name_ = adr.name_;
  42                 decoder_ = adr.decoder_;
  43                 callback_ = adr.callback_;
  44                 recurring_ = adr.recurring_;
  45                 wait_for_multiple_responses_ = adr.wait_for_multiple_responses_;
  46                 frequency_clock_ = adr.frequency_clock_;
  47                 timeout_clock_ = adr.timeout_clock_;
  48                 socket_ = adr.socket_;
  49         }
  50
  51         return *this;
  52 }
  53
  54 active_diagnostic_request_t::active_diagnostic_request_t()
  55         : bus_{nullptr},
  56           id_{0},
  57           handle_{nullptr},
  58           name_{""},
  59           decoder_{nullptr},
  60           callback_{nullptr},
  61           recurring_{false},
  62           wait_for_multiple_responses_{false},
  63           frequency_clock_{frequency_clock_t()},
  64           timeout_clock_{frequency_clock_t()}
  65 {}
  66
  67 active_diagnostic_request_t::active_diagnostic_request_t(const std::string& bus, DiagnosticRequest* request,
  68                 const std::string& name,
  69                 bool wait_for_multiple_responses,
  70                 const DiagnosticResponseDecoder decoder,
  71                 const DiagnosticResponseCallback callback,
  72                 float frequencyHz)
  73         : bus_{bus},
  74           id_{request->arbitration_id},
  75           handle_{nullptr},
  76           name_{name},
  77           decoder_{decoder},
  78           callback_{callback},
  79           recurring_{frequencyHz ? true : false},
  80           wait_for_multiple_responses_{wait_for_multiple_responses},
  81           frequency_clock_{frequency_clock_t(frequencyHz)},
  82           timeout_clock_{frequency_clock_t(10)}
  83 {}
  84
  85 active_diagnostic_request_t::~active_diagnostic_request_t()
  86 {
  87         socket_.close();
  88         delete handle_;
  89         handle_ = nullptr;
  90 }
  91
  92 uint32_t active_diagnostic_request_t::get_id() const
  93 {
  94         return id_;
  95 }
  96
  97 uint16_t active_diagnostic_request_t::get_pid() const
  98 {
  99         if (handle_->request.has_pid)
 100                 return handle_->request.pid;
 101         return ERROR_PID;
 102 }
 103
 104 DiagnosticRequestHandle* active_diagnostic_request_t::get_handle()
 105 {
 106         return handle_;
 107 }
 108
 109 const std::string active_diagnostic_request_t::get_name() const
 110 {
 111         return name_;
 112 }
 113
 114 std::string& active_diagnostic_request_t::get_prefix()
 115 {
 116         return active_diagnostic_request_t::prefix_;
 117 }
 118
 119 DiagnosticResponseDecoder& active_diagnostic_request_t::get_decoder()
 120 {
 121         return decoder_;
 122 }
 123
 124 DiagnosticResponseCallback& active_diagnostic_request_t::get_callback()
 125 {
 126         return callback_;
 127 }
 128
 129 bool active_diagnostic_request_t::get_recurring() const
 130 {
 131         return recurring_;
 132 }
 133
 134 frequency_clock_t& active_diagnostic_request_t::get_frequency_clock()
 135 {
 136         return frequency_clock_;
 137 }
 138
 139 frequency_clock_t& active_diagnostic_request_t::get_timeout_clock()
 140 {
 141         return timeout_clock_;
 142 }
 143
 144 utils::socketcan_bcm_t& active_diagnostic_request_t::get_socket()
 145 {
 146         return socket_;
 147 }
 148
 149 void active_diagnostic_request_t::set_handle(DiagnosticShims& shims, DiagnosticRequest* request)
 150 {
 151         handle_ = new DiagnosticRequestHandle(generate_diagnostic_request(&shims, request, nullptr));
 152 }
 153
 154 ///
 155 /// @brief Check if requested signal name is a diagnostic message. If the name
 156 ///  begin with the diagnostic message prefix then true else false.
 157 ///
 158 /// @param[in] name - A signal name.
 159 ///
 160 /// @return true if name began with the diagnostic message prefix else false.
 161 ///
 162 bool active_diagnostic_request_t::is_diagnostic_signal(const std::string& name)
 163 {
 164         const std::string p = active_diagnostic_request_t::prefix_ + "*";
 165         if(::fnmatch(p.c_str(), name.c_str(), FNM_CASEFOLD) == 0)
 166                 return true;
 167         return false;
 168 }
 169
 170 /// @brief Returns true if a sufficient response has been received for a
 171 /// diagnostic request.
 172 ///
 173 /// This is true when at least one response has been received and the request is
 174 /// configured to not wait for multiple responses. Functional broadcast requests
 175 /// may often wish to wait the full 100ms for modules to respond.
 176 bool active_diagnostic_request_t::response_received() const
 177 {
 178         return !wait_for_multiple_responses_ &&
 179                                 handle_->completed && handle_->success;
 180 }