Skip to content

Class nebula::drivers::connections::CanSocket::Builder

ClassList > nebula > drivers > connections > CanSocket > Builder

  • #include <can.hpp>

Public Functions

Type Name
Builder (const std::string & interface_name)
Build a CAN socket.
CanSocket bind ()
Bind the socket to the CAN interface.
Builder && set_polling_interval (int32_t interval_ms)
Set the interval at which the socket polls for new data.

Public Functions Documentation

function Builder

Build a CAN socket. 

inline explicit nebula::drivers::connections::CanSocket::Builder::Builder (
    const std::string & interface_name
)

Parameters:

  • interface_name The name of the CAN interface (e.g., "can0", "vcan0").

function bind

Bind the socket to the CAN interface. 

inline CanSocket nebula::drivers::connections::CanSocket::Builder::bind ()

function set_polling_interval

Set the interval at which the socket polls for new data. 

inline Builder && nebula::drivers::connections::CanSocket::Builder::set_polling_interval (
    int32_t interval_ms
)

Parameters:

  • interval_ms The desired polling interval.

The documentation for this class was generated from the following file src/nebula_core/nebula_core_hw_interfaces/include/nebula_core_hw_interfaces/nebula_hw_interfaces_common/connections/can.hpp