From 3d0186c54704ef5b408cd84d01f62a9d8ce6a718 Mon Sep 17 00:00:00 2001 From: Pavel Kirienko Date: Thu, 28 Jan 2016 00:54:22 +0300 Subject: [PATCH] SocketCAN doc comments --- libuavcan_drivers/linux/include/uavcan_linux/socketcan.hpp | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/libuavcan_drivers/linux/include/uavcan_linux/socketcan.hpp b/libuavcan_drivers/linux/include/uavcan_linux/socketcan.hpp index cc08b6ae8c..d56980bcc6 100644 --- a/libuavcan_drivers/linux/include/uavcan_linux/socketcan.hpp +++ b/libuavcan_drivers/linux/include/uavcan_linux/socketcan.hpp @@ -607,6 +607,12 @@ public: /** * Multiplexing container for multiple SocketCAN sockets. * Uses ppoll() for multiplexing. + * + * When an interface becomes down/disconnected while the node is running, + * the driver will silently exclude it from the IO loop and continue to run on the remaining interfaces. + * When all interfaces become down/disconnected, the driver will throw @ref AllIfacesDownException + * from @ref SocketCanDriver::select(). + * Whether a certain interface is down can be checked with @ref SocketCanDriver::isIfaceDown(). */ class SocketCanDriver : public uavcan::ICanDriver {