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

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

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

Public Types
using	Base
using	IdentifierWildcard = middleware::IdentifierWildcard

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

Definition at line 213 of file interprocess.h.

Member Typedef Documentation

Base

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

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

Initial value:

 PortalBase<InterProcessPortalImplementation<InnerTransporter, PortalBase,
                                                            ImplementationTag>,
                            InnerTransporter, ImplementationTag>

Definition at line 219 of file interprocess.h.

IdentifierWildcard

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

using goby::zeromq::InterProcessPortalImplementation< InnerTransporter, PortalBase, ImplementationTag >::IdentifierWildcard = middleware::IdentifierWildcard

Definition at line 222 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::zeromq::InterProcessPortalImplementation< InnerTransporter, PortalBase, ImplementationTag >::InterProcessPortalImplementation ( const protobuf::InterProcessPortalConfig & cfg )

inline

Definition at line 224 of file interprocess.h.

InterProcessPortalImplementation() [2/2]

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

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

inline

Definition at line 233 of file interprocess.h.

~InterProcessPortalImplementation()

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

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

inline

Definition at line 244 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::zeromq::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 257 of file interprocess.h.

ready()

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

void goby::zeromq::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).

Definition at line 254 of file interprocess.h.

Member Data Documentation

Base

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

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

Definition at line 259 of file interprocess.h.

---

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

• goby/zeromq/transport/interprocess.h