2 * Copyright (C) 2015, 2016 "IoT.bzh"
3 * Author "Romain Forlot" <romain.forlot@iot.bzh>
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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
21 #include "active-diagnostic-request.hpp"
23 #include "../binding/application.hpp"
25 #define AFB_ERROR_PID 0xFF
27 std::string active_diagnostic_request_t::prefix_ = "diagnostic_messages";
29 bool active_diagnostic_request_t::operator==(const active_diagnostic_request_t& b)
31 return (bus_ == b.bus_ && id_ == b.id_ && handle_ == b.handle_);
34 active_diagnostic_request_t& active_diagnostic_request_t::operator=(const active_diagnostic_request_t& adr)
40 handle_ = adr.handle_;
42 decoder_ = adr.decoder_;
43 callback_ = adr.callback_;
44 recurring_ = adr.recurring_;
45 permanent_ = adr.permanent_;
46 wait_for_multiple_responses_ = adr.wait_for_multiple_responses_;
47 frequency_clock_ = adr.frequency_clock_;
48 timeout_clock_ = adr.timeout_clock_;
49 socket_ = adr.socket_;
55 active_diagnostic_request_t::active_diagnostic_request_t()
64 wait_for_multiple_responses_{false},
65 frequency_clock_{frequency_clock_t()},
66 timeout_clock_{frequency_clock_t()},
70 active_diagnostic_request_t::active_diagnostic_request_t(const std::string& bus, uint32_t id,
71 const std::string& name,
72 bool wait_for_multiple_responses,
73 const DiagnosticResponseDecoder decoder,
74 const DiagnosticResponseCallback callback,
83 recurring_{frequencyHz ? true : false},
84 permanent_{permanent},
85 wait_for_multiple_responses_{wait_for_multiple_responses},
86 frequency_clock_{frequency_clock_t(frequencyHz)},
87 timeout_clock_{frequency_clock_t(10)},
91 active_diagnostic_request_t::~active_diagnostic_request_t()
98 uint32_t active_diagnostic_request_t::get_id() const
103 uint16_t active_diagnostic_request_t::get_pid() const
105 if (handle_->request.has_pid)
106 return handle_->request.pid;
107 return AFB_ERROR_PID;
110 DiagnosticRequestHandle* active_diagnostic_request_t::get_handle()
115 const std::string active_diagnostic_request_t::get_name() const
120 std::string& active_diagnostic_request_t::get_prefix()
122 return active_diagnostic_request_t::prefix_;
125 DiagnosticResponseDecoder& active_diagnostic_request_t::get_decoder()
130 DiagnosticResponseCallback& active_diagnostic_request_t::get_callback()
135 bool active_diagnostic_request_t::get_recurring() const
140 bool active_diagnostic_request_t::get_permanent() const
145 frequency_clock_t& active_diagnostic_request_t::get_frequency_clock()
147 return frequency_clock_;
150 frequency_clock_t& active_diagnostic_request_t::get_timeout_clock()
152 return timeout_clock_;
155 utils::socketcan_bcm_t& active_diagnostic_request_t::get_socket()
160 void active_diagnostic_request_t::set_handle(DiagnosticShims& shims, DiagnosticRequest* request)
162 handle_ = new DiagnosticRequestHandle(generate_diagnostic_request(&shims, request, nullptr));
166 /// @brief Check if requested signal name is a diagnostic message. If the name
167 /// begin with the diagnostic message prefix then true else false.
169 /// @param[in] name - A signal name.
171 /// @return true if name began with the diagnostic message prefix else false.
173 bool active_diagnostic_request_t::is_diagnostic_signal(const std::string& name)
175 const std::string p = active_diagnostic_request_t::prefix_ + "*";
176 if(::fnmatch(p.c_str(), name.c_str(), FNM_CASEFOLD) == 0)
181 /// @brief Returns true if a sufficient response has been received for a
182 /// diagnostic request.
184 /// This is true when at least one response has been received and the request is
185 /// configured to not wait for multiple responses. Functional broadcast requests
186 /// may often wish to wait the full 100ms for modules to respond.
187 bool active_diagnostic_request_t::response_received() const
189 return !wait_for_multiple_responses_ &&
190 handle_->completed && handle_->success;