Lely core libraries 2.3.4
lely::io::VirtualCanChannel Class Reference

A virtual CAN channel. More...

#include <vcan.hpp>

Inheritance diagram for lely::io::VirtualCanChannel:
Collaboration diagram for lely::io::VirtualCanChannel:

Public Member Functions

 VirtualCanChannel (io_ctx_t *ctx, ev_exec_t *exec, size_t rxlen=0)
 
 ~VirtualCanChannel ()
 
CanControllerBase get_ctrl () const noexcept
 
void open (const io_can_ctrl_t *ctrl) noexcept
 
bool is_open () const noexcept
 
void close () noexcept
 
- Public Member Functions inherited from lely::io::CanChannelBase
CanBusFlag get_flags () const
 
int read (can_msg *msg, can_err *err, ::std::chrono::nanoseconds *dp, int timeout, ::std::error_code &ec) noexcept
 
bool read (can_msg *msg, can_err *err=nullptr, ::std::chrono::nanoseconds *dp=nullptr, int timeout=-1)
 
void submit_read (struct io_can_chan_read &read) noexcept
 
template<class F >
void submit_read (can_msg *msg, can_err *err, ::std::chrono::nanoseconds *dp, ev_exec_t *exec, F &&f)
 
template<class F >
void submit_read (can_msg *msg, can_err *err, ::std::chrono::nanoseconds *dp, F &&f)
 
bool cancel_read (struct io_can_chan_read &read) noexcept
 
bool abort_read (struct io_can_chan_read &read) noexcept
 
ev::Future< int, intasync_read (ev_exec_t *exec, can_msg *msg, can_err *err=nullptr, timespec *tp=nullptr, struct io_can_chan_read **pread=nullptr)
 
ev::Future< int, intasync_read (can_msg *msg, can_err *err=nullptr, timespec *tp=nullptr, struct io_can_chan_read **pread=nullptr)
 
void write (const can_msg &msg, int timeout, ::std::error_code &ec) noexcept
 
void write (const can_msg &msg, int timeout=-1)
 
void submit_write (struct io_can_chan_write &write) noexcept
 
template<class F >
void submit_write (const can_msg &msg, ev_exec_t *exec, F &&f)
 
template<class F >
void submit_write (const can_msg &msg, F &&f)
 
bool cancel_write (struct io_can_chan_write &write) noexcept
 
bool abort_write (struct io_can_chan_write &write) noexcept
 
ev::Future< void, intasync_write (ev_exec_t *exec, const can_msg &msg, struct io_can_chan_write **pwrite=nullptr)
 
ev::Future< void, intasync_write (const can_msg &msg, struct io_can_chan_write **pwrite=nullptr)
 
- Public Member Functions inherited from lely::io::Device
ContextBase get_ctx () const noexcept
 
ev::Executor get_executor () const noexcept
 
bool cancel (ev_task &task) noexcept
 
::std::size_t cancel_all () noexcept
 
bool abort (ev_task &task) noexcept
 
::std::size_t abort_all () noexcept
 

Detailed Description

A virtual CAN channel.

Definition at line 116 of file vcan.hpp.

Constructor & Destructor Documentation

◆ VirtualCanChannel()

lely::io::VirtualCanChannel::VirtualCanChannel ( io_ctx_t ctx,
ev_exec_t exec,
size_t  rxlen = 0 
)
inline
See also
io_vcan_chan_create()

Definition at line 119 of file vcan.hpp.

◆ ~VirtualCanChannel()

lely::io::VirtualCanChannel::~VirtualCanChannel ( )
inline
See also
io_vcan_chan_destroy()

Definition at line 143 of file vcan.hpp.

Member Function Documentation

◆ get_ctrl()

CanControllerBase lely::io::VirtualCanChannel::get_ctrl ( ) const
inlinenoexcept
See also
io_vcan_chan_get_ctrl()

Definition at line 147 of file vcan.hpp.

◆ open()

void lely::io::VirtualCanChannel::open ( const io_can_ctrl_t ctrl)
inlinenoexcept
See also
io_vcan_chan_open()

Definition at line 153 of file vcan.hpp.

◆ is_open()

bool lely::io::VirtualCanChannel::is_open ( ) const
inlinenoexcept
See also
io_vcan_chan_is_open()

Definition at line 159 of file vcan.hpp.

◆ close()

void lely::io::VirtualCanChannel::close ( )
inlinenoexcept
See also
io_vcan_chan_close()

Definition at line 165 of file vcan.hpp.


The documentation for this class was generated from the following file: