Lely core libraries  2.2.5
can_rt.hpp File Reference

This header file is part of the I/O library; it contains the C++ interface for the CAN frame router. More...

#include <lely/io2/can.hpp>
#include <lely/io2/can_rt.h>
#include <utility>
Include dependency graph for can_rt.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

class  lely::io::detail::CanRouterReadFrameWrapper< F >
 
class  lely::io::CanRouterReadFrame
 A CAN frame read operation suitable for use with a CAN frame router. More...
 
class  lely::io::detail::CanRouterReadErrorWrapper< F >
 
class  lely::io::CanRouterReadError
 A CAN error frame read operation suitable for use with a CAN frame router. More...
 
class  lely::io::CanRouter
 A CAN frame rounter. This class is a wrapper around #io_can_rt_t*. More...
 

Functions

template<class F >
typename ::std::enable_if< compat::is_invocable< F, const can_msg *, ::std::error_code >::value, detail::CanRouterReadFrameWrapper< F > * >::type lely::io::make_can_router_read_frame_wrapper (uint_least32_t id, CanFlag flags, F &&f)
 Creates a CAN frame read operation with a completion task. More...
 
template<class F >
typename ::std::enable_if< compat::is_invocable< F, const can_err *, ::std::error_code >::value, detail::CanRouterReadErrorWrapper< F > * >::type lely::io::make_can_router_read_error_wrapper (F &&f)
 Creates a CAN error frame read operation with a completion task. More...
 

Detailed Description

This header file is part of the I/O library; it contains the C++ interface for the CAN frame router.

See also
lely/io2/can_rt.h
Author
J. S. Seldenthuis jseld.nosp@m.enth.nosp@m.uis@l.nosp@m.ely..nosp@m.com

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Definition in file can_rt.hpp.

Function Documentation

◆ make_can_router_read_frame_wrapper()

template<class F >
typename ::std::enable_if< compat::is_invocable<F, const can_msg*, ::std::error_code>::value, detail::CanRouterReadFrameWrapper<F>*>::type lely::io::make_can_router_read_frame_wrapper ( uint_least32_t  id,
CanFlag  flags,
F &&  f 
)
inline

Creates a CAN frame read operation with a completion task.

The operation deletes itself after it is completed, so it MUST NOT be deleted once it is submitted to a CAN frame router.

Definition at line 76 of file can_rt.hpp.

◆ make_can_router_read_error_wrapper()

template<class F >
typename ::std::enable_if< compat::is_invocable<F, const can_err*, ::std::error_code>::value, detail::CanRouterReadErrorWrapper<F>*>::type lely::io::make_can_router_read_error_wrapper ( F &&  f)
inline

Creates a CAN error frame read operation with a completion task.

The operation deletes itself after it is completed, so it MUST NOT be deleted once it is submitted to a CAN frame router.

Definition at line 163 of file can_rt.hpp.