#include <memory>
#include "utils/Hub.hxx"

Classes
class	GCAdapterBase
	Publicly visible API for the gridconnect-to-CAN bridge. More...

class	GcPacketPrinter
	Create this port for a CAN hub and all packets will be written to stdout in gridconnect format. More...

Functions
void	create_gc_port_for_can_hub (CanHubFlow can_hub, int fd, Notifiable on_exit=nullptr, bool use_select=false)
	Creates a new port on a CAN hub in gridconnect format for a select-compatible file descriptor.

Detailed Description

Copyright: Copyright (c) 2013, Balazs Racz All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Interface for creating gridconnect parser/renderer pipe components.

Author: Balazs Racz

Date: 20 May 2013

Definition in file GridConnectHub.hxx.

Function Documentation

◆ create_gc_port_for_can_hub()

void create_gc_port_for_can_hub	(	CanHubFlow *	can_hub,
		int	fd,
		Notifiable *	on_exit = `nullptr`,
		bool	use_select = `false`
	)

Creates a new port on a CAN hub in gridconnect format for a select-compatible file descriptor.

The port will automatically be closed, deleted and on_exit notified when the fd encounters an error.

NOTE(balazs.racz): this could be expanded to return an object pointer via which the port can be closed.

Parameters

can_hub	the raw CAN packets are coming/going to this object.
fd	the file descriptor of the port to send/receive the gridconnect ascii data to/from.
on_exit	is a notifiable (may be null) which will be called in case an error is encountered on this port and the port is subsequently closed.
use_select	when true, the FD will be used with select, when false, separate threads will be started with blocking read and write calls.

Definition at line 525 of file GridConnectHub.cxx.

Classes

Functions

Detailed Description

Function Documentation

◆ create_gc_port_for_can_hub()