low-can-binding/binding/low-can-subscription.hpp

   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   #pragma once
  19
  20 #include <string>
  21 #include <cmath>
  22 #include <utility>
  23
  24 #include "low-can-socket.hpp"
  25 #include "../can/can-signals.hpp"
  26 #include "../diagnostic/diagnostic-message.hpp"
  27 #include "../utils/socketcan-bcm.hpp"
  28
  29 /// @brief The subscription class has a context that can handle all needed values to describe a subscription
  30 /// to the low-can binding. It can hold a CAN signal or a diagnostic message. A diagnostic message for OBD2 is
  31 /// special because there is only 1 listener to retrieve OBD2 requests. It is required that all diagnostic message
  32 /// subscriptions are in 1 object.
  33 class low_can_subscription_t : public low_can_socket_t
  34 {
  35 private:
  36         afb_event_t event_; ///< event_ - application framework event used to push on client
  37
  38 public:
  39         using low_can_socket_t::low_can_socket_t;
  40
  41         afb_event_t get_event();
  42         void set_event(afb_event_t event);
  43 };