goby::zenoh::InterProcessPortalImplementation< InnerTransporter, PortalBase, ImplementationTag > Class Template Reference

#include <goby/zenoh/transport/interprocess.h>

Inheritance diagram for goby::zenoh::InterProcessPortalImplementation< InnerTransporter, PortalBase, ImplementationTag >:

Public Types
using	Base = PortalBase< InterProcessPortalImplementation< InnerTransporter, PortalBase, ImplementationTag >, InnerTransporter, ImplementationTag >

Public Member Functions
	InterProcessPortalImplementation (const protobuf::InterProcessPortalConfig &cfg)
	InterProcessPortalImplementation (InnerTransporter &inner, const protobuf::InterProcessPortalConfig &cfg)
	~InterProcessPortalImplementation ()
void	ready ()
	When using hold functionality, call when the process is ready to receive publications (typically done after most or all subscribe calls)
bool	hold_state ()
	When using hold functionality, returns whether the system is holding (true) and thus waiting for all processes to connect and be ready, or running (false).

Public Attributes
friend	Base

Detailed Description

template<typename InnerTransporter, template< typename Derived, typename InnerTransporterType, typename ImplementationTag_ > class PortalBase, typename ImplementationTag>
class goby::zenoh::InterProcessPortalImplementation< InnerTransporter, PortalBase, ImplementationTag >

Definition at line 75 of file interprocess.h.

Member Typedef Documentation

Base

template<typename InnerTransporter , template< typename Derived, typename InnerTransporterType, typename ImplementationTag_ > class PortalBase, typename ImplementationTag >

using goby::zenoh::InterProcessPortalImplementation< InnerTransporter, PortalBase, ImplementationTag >::Base = PortalBase< InterProcessPortalImplementation<InnerTransporter, PortalBase, ImplementationTag>, InnerTransporter, ImplementationTag>

Definition at line 81 of file interprocess.h.

Constructor & Destructor Documentation

InterProcessPortalImplementation() [1/2]

template<typename InnerTransporter , template< typename Derived, typename InnerTransporterType, typename ImplementationTag_ > class PortalBase, typename ImplementationTag >

goby::zenoh::InterProcessPortalImplementation< InnerTransporter, PortalBase, ImplementationTag >::InterProcessPortalImplementation ( const protobuf::InterProcessPortalConfig &  cfg )

inline

Definition at line 85 of file interprocess.h.

InterProcessPortalImplementation() [2/2]

template<typename InnerTransporter , template< typename Derived, typename InnerTransporterType, typename ImplementationTag_ > class PortalBase, typename ImplementationTag >

goby::zenoh::InterProcessPortalImplementation< InnerTransporter, PortalBase, ImplementationTag >::InterProcessPortalImplementation ( InnerTransporter &  inner, const protobuf::InterProcessPortalConfig &  cfg  )

inline

Definition at line 90 of file interprocess.h.

~InterProcessPortalImplementation()

template<typename InnerTransporter , template< typename Derived, typename InnerTransporterType, typename ImplementationTag_ > class PortalBase, typename ImplementationTag >

goby::zenoh::InterProcessPortalImplementation< InnerTransporter, PortalBase, ImplementationTag >::~InterProcessPortalImplementation ( )

inline

Definition at line 97 of file interprocess.h.

Member Function Documentation

hold_state()

template<typename InnerTransporter , template< typename Derived, typename InnerTransporterType, typename ImplementationTag_ > class PortalBase, typename ImplementationTag >

bool goby::zenoh::InterProcessPortalImplementation< InnerTransporter, PortalBase, ImplementationTag >::hold_state ( )

inline

When using hold functionality, returns whether the system is holding (true) and thus waiting for all processes to connect and be ready, or running (false).

Definition at line 128 of file interprocess.h.

ready()

template<typename InnerTransporter , template< typename Derived, typename InnerTransporterType, typename ImplementationTag_ > class PortalBase, typename ImplementationTag >

void goby::zenoh::InterProcessPortalImplementation< InnerTransporter, PortalBase, ImplementationTag >::ready ( )

inline

When using hold functionality, call when the process is ready to receive publications (typically done after most or all subscribe calls)

Announced with a Zenoh liveliness token, which disappears on its own if this process dies, so the announcement needs nothing to retract it.

Definition at line 111 of file interprocess.h.

Member Data Documentation

Base

template<typename InnerTransporter , template< typename Derived, typename InnerTransporterType, typename ImplementationTag_ > class PortalBase, typename ImplementationTag >

friend goby::zenoh::InterProcessPortalImplementation< InnerTransporter, PortalBase, ImplementationTag >::Base

Definition at line 130 of file interprocess.h.

---

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

• goby/zenoh/transport/interprocess.h