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/application.hpp"
  24
  25 #define AFB_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           socket_{}
  66 {}
  67
  68 active_diagnostic_request_t::active_diagnostic_request_t(const std::string& bus, uint32_t id,
  69                 const std::string& name,
  70                 bool wait_for_multiple_responses,
  71                 const DiagnosticResponseDecoder decoder,
  72                 const DiagnosticResponseCallback callback,
  73                 float frequencyHz)
  74         : bus_{bus},
  75           id_{id},
  76           handle_{nullptr},
  77           name_{name},
  78           decoder_{decoder},
  79           callback_{callback},
  80           recurring_{frequencyHz ? true : false},
  81           wait_for_multiple_responses_{wait_for_multiple_responses},
  82           frequency_clock_{frequency_clock_t(frequencyHz)},
  83           timeout_clock_{frequency_clock_t(10)},
  84           socket_{}
  85 {}
  86
  87 active_diagnostic_request_t::~active_diagnostic_request_t()
  88 {
  89         socket_.close();
  90         delete handle_;
  91         handle_ = nullptr;
  92 }
  93
  94 uint32_t active_diagnostic_request_t::get_id() const
  95 {
  96         return id_;
  97 }
  98
  99 uint16_t active_diagnostic_request_t::get_pid() const
 100 {
 101         if (handle_->request.has_pid)
 102                 return handle_->request.pid;
 103         return AFB_ERROR_PID;
 104 }
 105
 106 DiagnosticRequestHandle* active_diagnostic_request_t::get_handle()
 107 {
 108         return handle_;
 109 }
 110
 111 const std::string active_diagnostic_request_t::get_name() const
 112 {
 113         return name_;
 114 }
 115
 116 std::string& active_diagnostic_request_t::get_prefix()
 117 {
 118         return active_diagnostic_request_t::prefix_;
 119 }
 120
 121 DiagnosticResponseDecoder& active_diagnostic_request_t::get_decoder()
 122 {
 123         return decoder_;
 124 }
 125
 126 DiagnosticResponseCallback& active_diagnostic_request_t::get_callback()
 127 {
 128         return callback_;
 129 }
 130
 131 bool active_diagnostic_request_t::get_recurring() const
 132 {
 133         return recurring_;
 134 }
 135
 136 frequency_clock_t& active_diagnostic_request_t::get_frequency_clock()
 137 {
 138         return frequency_clock_;
 139 }
 140
 141 frequency_clock_t& active_diagnostic_request_t::get_timeout_clock()
 142 {
 143         return timeout_clock_;
 144 }
 145
 146 utils::socketcan_bcm_t& active_diagnostic_request_t::get_socket()
 147 {
 148         return socket_;
 149 }
 150
 151 void active_diagnostic_request_t::set_handle(DiagnosticShims& shims, DiagnosticRequest* request)
 152 {
 153         handle_ = new DiagnosticRequestHandle(generate_diagnostic_request(&shims, request, nullptr));
 154 }
 155
 156 ///
 157 /// @brief Check if requested signal name is a diagnostic message. If the name
 158 ///  begin with the diagnostic message prefix then true else false.
 159 ///
 160 /// @param[in] name - A signal name.
 161 ///
 162 /// @return true if name began with the diagnostic message prefix else false.
 163 ///
 164 bool active_diagnostic_request_t::is_diagnostic_signal(const std::string& name)
 165 {
 166         const std::string p = active_diagnostic_request_t::prefix_ + "*";
 167         if(::fnmatch(p.c_str(), name.c_str(), FNM_CASEFOLD) == 0)
 168                 return true;
 169         return false;
 170 }
 171
 172 /// @brief Returns true if a sufficient response has been received for a
 173 /// diagnostic request.
 174 ///
 175 /// This is true when at least one response has been received and the request is
 176 /// configured to not wait for multiple responses. Functional broadcast requests
 177 /// may often wish to wait the full 100ms for modules to respond.
 178 bool active_diagnostic_request_t::response_received() const
 179 {
 180         return !wait_for_multiple_responses_ &&
 181                                 handle_->completed && handle_->success;
 182 }