Remote Call Framework 3.1
RCF::SubscriptionParms Class Reference

General configuration of a subscription. More...

#include <SubscriptionService.hpp>

Public Member Functions

void setTopicName (const std::string &publisherName)
 Sets the topic name of the subscription. The default topic name is the name of the RCF interface of the subscription. More...
 
std::string getTopicName () const
 Gets the topic name of the subscription. The default topic name is the name of the RCF interface of the subscription. More...
 
void setPublisherEndpoint (const Endpoint &publisherEp)
 Sets the network endpoint of the publishing server. More...
 
void setPublisherEndpoint (I_RcfClient &rcfClient)
 Sets the network endpoint of the publishing server. More...
 
void setOnSubscriptionDisconnect (OnSubscriptionDisconnect onSubscriptionDisconnect)
 Configures a callback to be called whenever the subscriber is disconnected from the publisher. More...
 
void setOnAsyncSubscribeCompleted (OnAsyncSubscribeCompleted onAsyncSubscribeCompleted)
 Configures a callback to be called when an asynchronous subscription connection is established. More...
 

Detailed Description

General configuration of a subscription.

Member Function Documentation

◆ setTopicName()

void RCF::SubscriptionParms::setTopicName ( const std::string &  publisherName)

Sets the topic name of the subscription. The default topic name is the name of the RCF interface of the subscription.

◆ getTopicName()

std::string RCF::SubscriptionParms::getTopicName ( ) const

Gets the topic name of the subscription. The default topic name is the name of the RCF interface of the subscription.

◆ setPublisherEndpoint() [1/2]

void RCF::SubscriptionParms::setPublisherEndpoint ( const Endpoint publisherEp)

Sets the network endpoint of the publishing server.

◆ setPublisherEndpoint() [2/2]

void RCF::SubscriptionParms::setPublisherEndpoint ( I_RcfClient rcfClient)

Sets the network endpoint of the publishing server.

◆ setOnSubscriptionDisconnect()

void RCF::SubscriptionParms::setOnSubscriptionDisconnect ( OnSubscriptionDisconnect  onSubscriptionDisconnect)

Configures a callback to be called whenever the subscriber is disconnected from the publisher.

◆ setOnAsyncSubscribeCompleted()

void RCF::SubscriptionParms::setOnAsyncSubscribeCompleted ( OnAsyncSubscribeCompleted  onAsyncSubscribeCompleted)

Configures a callback to be called when an asynchronous subscription connection is established.


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