goby::zeromq::InterProcessPortalImplementation< InnerTransporter, PortalBase > Class Template Reference

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

Inheritance diagram for goby::zeromq::InterProcessPortalImplementation< InnerTransporter, PortalBase >:

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

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 > class PortalBase>
class goby::zeromq::InterProcessPortalImplementation< InnerTransporter, PortalBase >

Definition at line 291 of file interprocess.h.

Member Typedef Documentation

Base

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

using goby::zeromq::InterProcessPortalImplementation< InnerTransporter, PortalBase >::Base = PortalBase<InterProcessPortalImplementation<InnerTransporter, PortalBase>, InnerTransporter>

Definition at line 296 of file interprocess.h.

Constructor & Destructor Documentation

InterProcessPortalImplementation() [1/2]

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

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

inline

Definition at line 299 of file interprocess.h.

InterProcessPortalImplementation() [2/2]

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

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

inline

Definition at line 308 of file interprocess.h.

~InterProcessPortalImplementation()

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

goby::zeromq::InterProcessPortalImplementation< InnerTransporter, PortalBase >::~InterProcessPortalImplementation ( )

inline

Definition at line 319 of file interprocess.h.

Member Function Documentation

hold_state()

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

bool goby::zeromq::InterProcessPortalImplementation< InnerTransporter, PortalBase >::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 332 of file interprocess.h.

ready()

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

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

inline

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

Definition at line 329 of file interprocess.h.

Member Data Documentation

Base

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

friend goby::zeromq::InterProcessPortalImplementation< InnerTransporter, PortalBase >::Base

Definition at line 334 of file interprocess.h.

---

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

• goby/zeromq/transport/interprocess.h