Goby3  3.1.5a
2024.05.23
goby::middleware::SerializationInterModuleSubscription Class Reference

Represents a(n) (un)subscription from an InterModuleForwarder. More...

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

Inheritance diagram for goby::middleware::SerializationInterModuleSubscription:
goby::middleware::SerializationHandlerBase<> goby::middleware::SerializationHandlerPostSelector< void >

Public Types

typedef std::function< void(const protobuf::SerializerTransporterMessage &d)> HandlerType
 
- Public Types inherited from goby::middleware::SerializationHandlerBase<>
enum  SubscriptionAction
 

Public Member Functions

 SerializationInterModuleSubscription (HandlerType handler, const intermodule::protobuf::Subscription sub)
 
std::string::const_iterator post (std::string::const_iterator b, std::string::const_iterator e) const override
 
std::vector< char >::const_iterator post (std::vector< char >::const_iterator b, std::vector< char >::const_iterator e) const override
 
const charpost (const char *b, const char *e) const override
 
SerializationHandlerBase ::SubscriptionAction action () const override
 
const std::string & type_name () const override
 
const Groupsubscribed_group () const override
 
int scheme () const override
 
std::string subscriber_id () const override
 
- Public Member Functions inherited from goby::middleware::SerializationHandlerBase<>
 SerializationHandlerBase ()=default
 
virtual ~SerializationHandlerBase ()=default
 
virtual const std::string & type_name () const=0
 
virtual const Groupsubscribed_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

Represents a(n) (un)subscription from an InterModuleForwarder.

Definition at line 455 of file serialization_handlers.h.

Member Typedef Documentation

◆ HandlerType

Constructor & Destructor Documentation

◆ SerializationInterModuleSubscription()

goby::middleware::SerializationInterModuleSubscription::SerializationInterModuleSubscription ( HandlerType  handler,
const intermodule::protobuf::Subscription  sub 
)
inline

Definition at line 460 of file serialization_handlers.h.

Member Function Documentation

◆ action()

SerializationHandlerBase ::SubscriptionAction goby::middleware::SerializationInterModuleSubscription::action ( ) const
inlineoverride

Definition at line 483 of file serialization_handlers.h.

◆ post() [1/3]

const char* goby::middleware::SerializationInterModuleSubscription::post ( const char b,
const char e 
) const
inlineoverride

Definition at line 481 of file serialization_handlers.h.

◆ post() [2/3]

std::string::const_iterator goby::middleware::SerializationInterModuleSubscription::post ( std::string::const_iterator  b,
std::string::const_iterator  e 
) const
inlineoverride

Definition at line 467 of file serialization_handlers.h.

◆ post() [3/3]

std::vector<char>::const_iterator goby::middleware::SerializationInterModuleSubscription::post ( std::vector< char >::const_iterator  b,
std::vector< char >::const_iterator  e 
) const
inlineoverride

Definition at line 474 of file serialization_handlers.h.

◆ scheme()

int goby::middleware::SerializationInterModuleSubscription::scheme ( ) const
inlineoverride

Definition at line 499 of file serialization_handlers.h.

◆ subscribed_group()

const Group& goby::middleware::SerializationInterModuleSubscription::subscribed_group ( ) const
inlineoverride

Definition at line 498 of file serialization_handlers.h.

◆ subscriber_id()

std::string goby::middleware::SerializationInterModuleSubscription::subscriber_id ( ) const
inlineoverride

Definition at line 501 of file serialization_handlers.h.

◆ type_name()

const std::string& goby::middleware::SerializationInterModuleSubscription::type_name ( ) const
inlineoverride

Definition at line 497 of file serialization_handlers.h.


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