ethernet_interface_info.h
Go to the documentation of this file.
00001 /*********************************************************************
00002  * Software License Agreement (BSD License)
00003  *
00004  *  Copyright (c) 2008, Willow Garage, Inc.
00005  *  All rights reserved.
00006  *
00007  *  Redistribution and use in source and binary forms, with or without
00008  *  modification, are permitted provided that the following conditions
00009  *  are met:
00010  *
00011  *   * Redistributions of source code must retain the above copyright
00012  *     notice, this list of conditions and the following disclaimer.
00013  *   * Redistributions in binary form must reproduce the above
00014  *     copyright notice, this list of conditions and the following
00015  *     disclaimer in the documentation and/or other materials provided
00016  *     with the distribution.
00017  *   * Neither the name of the Willow Garage nor the names of its
00018  *     contributors may be used to endorse or promote products derived
00019  *     from this software without specific prior written permission.
00020  *
00021  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00022  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00023  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00024  *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
00025  *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00026  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00027  *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00028  *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00029  *  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00030  *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
00031  *  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00032  *  POSSIBILITY OF SUCH DAMAGE.
00033  *********************************************************************/
00034 
00035 #ifndef ETHERNET_INTERFACE_INFO_H
00036 #define ETHERNET_INTERFACE_INFO_H
00037 
00038 #include <string>
00039 #include <stdint.h>
00040 
00041 #include <diagnostic_updater/DiagnosticStatusWrapper.h>
00042 
00043 struct EthtoolStats
00044 {
00045   EthtoolStats();
00046   uint64_t rx_errors_;
00047   uint64_t rx_crc_errors_;
00048   uint64_t rx_frame_errors_;
00049   uint64_t rx_align_errors_;
00050 
00051   EthtoolStats& operator-=(const EthtoolStats& right);
00052 };
00053 
00054 struct InterfaceState
00055 {
00056   InterfaceState() : up_(false), running_(false) {}
00057   bool up_;
00058   bool running_;
00059 };
00060 
00061 class EthernetInterfaceInfo
00062 {
00063 public:
00064   EthernetInterfaceInfo();
00065   void initialize(const std::string &interface);
00066   ~EthernetInterfaceInfo();  
00067 
00073   void publishDiagnostics(diagnostic_updater::DiagnosticStatusWrapper &d);
00074 
00075 protected:
00077   bool getEthtoolStats(EthtoolStats &stats);
00078 
00080   bool getInterfaceState(InterfaceState &state);
00081 
00083   std::string interface_;
00085   int sock_;
00087   unsigned n_stats_;
00089   char *ethtool_stats_buf_;
00090 
00091   // Indexes of statistics that come from ethtool ioctl
00092   // An index of -1 indicates that statistic is not available from network driver
00093   int rx_error_index_;
00094   int rx_crc_error_index_;
00095   int rx_frame_error_index_;
00096   int rx_align_error_index_;
00097 
00098 
00100   unsigned lost_link_count_;
00101 
00103   EthtoolStats orig_stats_;
00104   InterfaceState last_state_;
00105 };
00106 
00107 
00108 #endif //ETHERNET_INTERFACE_INFO_H


ethercat_hardware
Author(s): Rob Wheeler (email: wheeler@willowgarage.com), Maintained by Derek King (email: dking@willowgarage.com)
autogenerated on Thu Apr 24 2014 15:43:44