Goby3  3.1.4
2024.02.22
goby::middleware::InterProcessForwarder< InnerTransporter > Class Template Reference

Implements the forwarder concept for the interprocess layer. More...

#include <goby/middleware/io/detail/io_interface.h>

Public Types

using Base = InterProcessTransporterBase< InterProcessForwarder< InnerTransporter >, InnerTransporter >
 

Public Member Functions

 InterProcessForwarder (InnerTransporter &inner)
 Construct a forwarder for the interprocess layer. More...
 
virtual ~InterProcessForwarder ()
 

Public Attributes

friend Base
 

Detailed Description

template<typename InnerTransporter>
class goby::middleware::InterProcessForwarder< InnerTransporter >

Implements the forwarder concept for the interprocess layer.

The forwarder is intended to be used by inner nodes within the layer that do not connect directly to other nodes on that layer. For example, the main thread might instantiate a portal and then spawn several threads that instantiate forwarders. These auxiliary threads can then communicate on the interprocess layer as if they had a direct connection to other interprocess nodes.

Template Parameters
InnerTransporterThe type of the inner transporter used to forward data to and from this node

Definition at line 56 of file io_interface.h.

Member Typedef Documentation

◆ Base

template<typename InnerTransporter >
using goby::middleware::InterProcessForwarder< InnerTransporter >::Base = InterProcessTransporterBase<InterProcessForwarder<InnerTransporter>, InnerTransporter>

Definition at line 301 of file interprocess.h.

Constructor & Destructor Documentation

◆ InterProcessForwarder()

template<typename InnerTransporter >
goby::middleware::InterProcessForwarder< InnerTransporter >::InterProcessForwarder ( InnerTransporter &  inner)
inline

Construct a forwarder for the interprocess layer.

Parameters
innerA reference to the inner transporter used to forward messages to and from the portal

Definition at line 306 of file interprocess.h.

◆ ~InterProcessForwarder()

template<typename InnerTransporter >
virtual goby::middleware::InterProcessForwarder< InnerTransporter >::~InterProcessForwarder ( )
inlinevirtual

Definition at line 315 of file interprocess.h.

Member Data Documentation

◆ Base

template<typename InnerTransporter >
friend goby::middleware::InterProcessForwarder< InnerTransporter >::Base

Definition at line 323 of file interprocess.h.


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