low-can-binding/utils/socketcan.cpp

   1 /*
   2  * Copyright (C) 2015, 2016 ,2017 "IoT.bzh"
   3  * Author "Romain Forlot" <romain.forlot@iot.bzh>
   4  * Author "Loïc Collignon" <loic.collignon@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
   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 <unistd.h>
  19 #include <string>
  20 #include <linux/can/raw.h>
  21 #include <net/if.h>
  22 #include <sys/ioctl.h>
  23
  24 #include "socketcan.hpp"
  25
  26 namespace utils
  27 {
  28
  29         /// @brief Construct a default, invalid, socket.
  30         socketcan_t::socketcan_t()
  31                 : socket_{INVALID_SOCKET}
  32         {}
  33
  34         /// @brief Construct a socket by moving an existing one.
  35         socketcan_t::socketcan_t(socketcan_t&& s)
  36                 : socket_{s.socket_}
  37         {
  38                 ::memset(&tx_address_, 0, sizeof(tx_address_));
  39         }
  40
  41         socketcan_t& socketcan_t::operator=(const socketcan_t& s)
  42         {
  43                 socket_ = std::move(s.socket_);
  44                 return *this;
  45         }
  46
  47         socketcan_t::~socketcan_t()
  48         {
  49                 close();
  50                 socket_ = INVALID_SOCKET;
  51         }
  52
  53         const struct sockaddr_can& socketcan_t::get_tx_address() const
  54         {
  55                 return tx_address_;
  56         }
  57
  58         /// @brief Test if socket is valid.
  59         /// @return true if valid, false otherwise.
  60         socketcan_t::operator bool() const
  61         {
  62                 return socket_ != INVALID_SOCKET;
  63         }
  64
  65         /// @brief Open the socket.
  66         /// @param[in] domain Specifies the communications domain in which a socket is to be created.
  67         /// @param[in] type Specifies the type of socket to be created.
  68         /// @param[in] protocol Specifies a particular protocol to be used with the socket. Specifying a protocol of 0 causes socket() to use an unspecified default protocol appropriate for the requested socket type.
  69         /// @return Upon successful completion, shall return a non-negative integer, the socket file descriptor. Otherwise, a value of -1 shall be returned and errno set to indicate the error.
  70         int socketcan_t::open(int domain, int type, int protocol)
  71         {
  72                 close();
  73                 socket_ = ::socket(domain, type, protocol);
  74                 return socket_;
  75         }
  76
  77         /// @brief Close the socket.
  78         /// @return 0 if success.
  79         int socketcan_t::close()
  80         {
  81                 return socket_ != INVALID_SOCKET ? ::close(socket_) : 0;
  82         }
  83
  84         /// @brief Set socket option.
  85         /// @return 0 if success.
  86         int socketcan_t::setopt(int level, int optname, const void* optval, socklen_t optlen)
  87         {
  88                 return socket_ != INVALID_SOCKET ? ::setsockopt(socket_, level, optname, optval, optlen) : 0;
  89         }
  90
  91         /// @brief Get the file descriptor.
  92         /// @return The socket's file descriptor
  93         int socketcan_t::socket() const
  94         {
  95                 return socket_;
  96         }
  97 }