service_discovery
Public Member Functions | Friends | List of all members
servicediscovery::avahi::ServiceConfiguration Class Reference

Description and parameterization of a service. More...

#include <ServiceConfiguration.hpp>

Inheritance diagram for servicediscovery::avahi::ServiceConfiguration:
servicediscovery::avahi::ServiceDescription

Public Member Functions

 ServiceConfiguration ()
 
 ServiceConfiguration (const std::string &name, const std::string &type, uint16_t port=12000, uint16_t ttlInMS=0, bool publish=true)
 
 ServiceConfiguration (const ServiceDescription &description)
 
virtual ~ServiceConfiguration ()
 
uint16_t getPort () const
 
void setPort (uint16_t port)
 
void setTTL (uint16_t ttl)
 
uint16_t getTTL () const
 
void setPublishMode (bool mode)
 
bool getPublishMode () const
 
std::string toString ()
 
- Public Member Functions inherited from servicediscovery::avahi::ServiceDescription
 ServiceDescription ()
 
 ServiceDescription (const std::string &servicename)
 
virtual ~ServiceDescription ()
 
bool operator== (const ServiceDescription &other) const
 
bool operator!= (const ServiceDescription &other) const
 
std::string getName () const
 
void setName (const std::string &name)
 
bool compareWithoutTXT (const ServiceDescription &other) const
 
std::string getDescription (const std::string &label) const
 
void setDescription (const std::string &label, const std::string &description)
 
void setRawDescriptions (const std::list< std::string > &descriptions)
 
std::list< std::string > getRawDescriptions () const
 
std::vector< std::string > getLabels () const
 
void setType (const std::string &type)
 
std::string getType () const
 
void setProtocol (int protocol)
 
int getProtocol () const
 
std::string getProtocolString () const
 
void setDomain (const std::string &domain)
 
std::string getDomain () const
 
void setInterfaceIndex (int interfaceIndex)
 
int getInterfaceIndex () const
 

Friends

class ServiceDiscovery
 

Additional Inherited Members

- Protected Member Functions inherited from servicediscovery::avahi::ServiceDescription
int getDescriptionSize () const
 
- Protected Attributes inherited from servicediscovery::avahi::ServiceDescription
std::string name_
 
std::string type_
 
AvahiProtocol protocol_
 
std::string domain_
 
AvahiIfIndex interfaceIndex_
 
std::list< std::string > descriptions_
 
std::vector< std::string > labels_
 
- Static Protected Attributes inherited from servicediscovery::avahi::ServiceDescription
static const uint32_t mDNSMaxRecordSize = 200
 
static const uint32_t mDNSMaxPayloadSize = 1300
 

Detailed Description

Description and parameterization of a service.

Constructor & Destructor Documentation

◆ ServiceConfiguration() [1/3]

servicediscovery::avahi::ServiceConfiguration::ServiceConfiguration ( )

◆ ServiceConfiguration() [2/3]

servicediscovery::avahi::ServiceConfiguration::ServiceConfiguration ( const std::string &  name,
const std::string &  type,
uint16_t  port = 12000,
uint16_t  ttlInMS = 0,
bool  publish = true 
)
Parameters
nameName of service
typeType of service such as _foo_type._tcp
portCommunication port for avahi
ttlInMSTime-to-live for records
publishFlag to control the publishing mode, if service shall be published set to true

◆ ServiceConfiguration() [3/3]

servicediscovery::avahi::ServiceConfiguration::ServiceConfiguration ( const ServiceDescription description)

◆ ~ServiceConfiguration()

servicediscovery::avahi::ServiceConfiguration::~ServiceConfiguration ( )
virtual

Member Function Documentation

◆ getPort()

uint16_t servicediscovery::avahi::ServiceConfiguration::getPort ( ) const

◆ getPublishMode()

bool servicediscovery::avahi::ServiceConfiguration::getPublishMode ( ) const

◆ getTTL()

uint16_t servicediscovery::avahi::ServiceConfiguration::getTTL ( ) const

◆ setPort()

void servicediscovery::avahi::ServiceConfiguration::setPort ( uint16_t  port)

◆ setPublishMode()

void servicediscovery::avahi::ServiceConfiguration::setPublishMode ( bool  mode)

◆ setTTL()

void servicediscovery::avahi::ServiceConfiguration::setTTL ( uint16_t  ttl)

◆ toString()

std::string servicediscovery::avahi::ServiceConfiguration::toString ( )

General description of the service

Friends And Related Function Documentation

◆ ServiceDiscovery

friend class ServiceDiscovery
friend

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