goby::middleware::SerializationHandlerBase< Metadata > Class Template Reference

Base class for handling posting callbacks for serialized data types (interprocess and outer) More...

#include <goby/middleware/transport/serialization_handlers.h>

Inheritance diagram for goby::middleware::SerializationHandlerBase< Metadata >:

Public Types
enum class	SubscriptionAction { SUBSCRIBE , UNSUBSCRIBE , PUBLISHER_CALLBACK }

Public Member Functions
	SerializationHandlerBase ()=default
virtual	~SerializationHandlerBase ()=default
virtual const std::string &	type_name () const =0
virtual const Group &	subscribed_group () const =0
virtual int	scheme () const =0
virtual SubscriptionAction	action () const =0
std::thread::id	thread_id () const
virtual std::string	subscriber_id () const

Detailed Description

template<typename Metadata = void>
class goby::middleware::SerializationHandlerBase< Metadata >

Base class for handling posting callbacks for serialized data types (interprocess and outer)

Template Parameters

Metadata

metadata type (e.g. Publisher or Subscriber)

Definition at line 96 of file serialization_handlers.h.

Member Enumeration Documentation

SubscriptionAction

template<typename Metadata = void>

enum class goby::middleware::SerializationHandlerBase::SubscriptionAction

strong

Enumerator
SUBSCRIBE
UNSUBSCRIBE
PUBLISHER_CALLBACK

Definition at line 107 of file serialization_handlers.h.

Constructor & Destructor Documentation

SerializationHandlerBase()

template<typename Metadata = void>

goby::middleware::SerializationHandlerBase< Metadata >::SerializationHandlerBase ( )

default

~SerializationHandlerBase()

template<typename Metadata = void>

virtual goby::middleware::SerializationHandlerBase< Metadata >::~SerializationHandlerBase ( )

virtualdefault

Member Function Documentation

action()

template<typename Metadata = void>

virtual SubscriptionAction goby::middleware::SerializationHandlerBase< Metadata >::action ( ) const

pure virtual

Implemented in goby::middleware::SerializationSubscription< Data, scheme_id >, goby::middleware::IntervehicleSerializationSubscription< Data, scheme_id >, goby::middleware::PublisherCallback< Data, scheme_id, Metadata >, goby::middleware::SerializationUnSubscription< Data, scheme_id >, and goby::middleware::SerializationInterModuleSubscription.

scheme()

template<typename Metadata = void>

virtual int goby::middleware::SerializationHandlerBase< Metadata >::scheme ( ) const

pure virtual

Implemented in goby::middleware::SerializationSubscription< Data, scheme_id >, goby::middleware::IntervehicleSerializationSubscription< Data, scheme_id >, goby::middleware::PublisherCallback< Data, scheme_id, Metadata >, goby::middleware::SerializationUnSubscription< Data, scheme_id >, and goby::middleware::SerializationInterModuleSubscription.

subscribed_group()

template<typename Metadata = void>

virtual const Group & goby::middleware::SerializationHandlerBase< Metadata >::subscribed_group ( ) const

pure virtual

Implemented in goby::middleware::SerializationSubscription< Data, scheme_id >, goby::middleware::IntervehicleSerializationSubscription< Data, scheme_id >, goby::middleware::PublisherCallback< Data, scheme_id, Metadata >, goby::middleware::SerializationUnSubscription< Data, scheme_id >, and goby::middleware::SerializationInterModuleSubscription.

subscriber_id()

template<typename Metadata = void>

virtual std::string goby::middleware::SerializationHandlerBase< Metadata >::subscriber_id ( ) const

inlinevirtual

Reimplemented in goby::middleware::SerializationInterModuleSubscription.

Definition at line 116 of file serialization_handlers.h.

thread_id()

template<typename Metadata = void>

std::thread::id goby::middleware::SerializationHandlerBase< Metadata >::thread_id ( ) const

inline

Definition at line 115 of file serialization_handlers.h.

type_name()

template<typename Metadata = void>

virtual const std::string & goby::middleware::SerializationHandlerBase< Metadata >::type_name ( ) const

pure virtual

Implemented in goby::middleware::SerializationSubscription< Data, scheme_id >, goby::middleware::IntervehicleSerializationSubscription< Data, scheme_id >, goby::middleware::PublisherCallback< Data, scheme_id, Metadata >, goby::middleware::SerializationUnSubscription< Data, scheme_id >, and goby::middleware::SerializationInterModuleSubscription.

---

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

• goby/middleware/transport/serialization_handlers.h