OpenJAUS SAE SDK  6.0.0
Public Member Functions | Static Public Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
openjaus::transport::AS5669::JudpSettings Class Reference

#include <JudpSettings.h>

Inherits openjaus::transport::AS5669::JudpSettingsInterface.

Public Member Functions

 JudpSettings ()
 
virtual ~JudpSettings ()
 
short getPrimaryPort ()
 
void setPrimaryPort (short value)
 
short getSecondaryPort ()
 
void setSecondaryPort (short value)
 
bool isMulticastDiscoveryEnabled ()
 
void enableMulticastDiscovery (bool value)
 
JudpSettingsInterface::BroadcastMethod getBroadcastMethod ()
 
void setBroadcastMethod (JudpSettingsInterface::BroadcastMethod value)
 
std::string getMulticastAddress ()
 
void setMulticastAddress (std::string value)
 
bool isAckNakEnabled ()
 
void enableAckNak (bool value)
 
int getAckNakTimeout_ms ()
 
void setAckNakTimeout_ms (int value)
 
int getMaxAckNakRetries ()
 
void setMaxAckNakRetries (int value)
 
uint8 getTimeToLive ()
 
void setTimeToLive (uint8 value)
 
virtual JudpSettingsInterface::UnknownRouteResolutionMethod::Enum getUnknownRouteResolutionMethod () const
 
virtual void setUnknownRouteResolutionMethod (JudpSettingsInterface::UnknownRouteResolutionMethod::Enum value)
 
virtual bool isLargeMessageBurstSendEnabled ()
 
virtual int getLargeMessageBurstLength ()
 
virtual void setLargeMessageBurstLength (int value)
 
virtual uint32 getMaxQueueSize ()
 
bool areValid ()
 
- Public Member Functions inherited from openjaus::transport::AS5669::JudpSettingsInterface
 JudpSettingsInterface ()
 
virtual ~JudpSettingsInterface ()
 
- Public Member Functions inherited from openjaus::transport::InterfaceSettingsInterface
 InterfaceSettingsInterface ()
 
virtual ~InterfaceSettingsInterface ()
 

Static Public Member Functions

static JudpSettingsloadFromConfFile (const std::string &componentName)
 

Private Member Functions

void setInterfaceSettings (InterfaceSettings *settings)
 

Static Private Member Functions

static JudpSettingsInterface::BroadcastMethod loadBroadcastMethod ()
 
static JudpSettingsInterface::UnknownRouteResolutionMethod::Enum loadUnknownRouteResolutionMethod ()
 
static void verifySettingsAndThrowIfError (JudpSettings *settings)
 

Private Attributes

InterfaceSettingsinterfaceSettings
 
short primaryPort
 
short secondaryPort
 
bool multicastDiscoveryEnabled
 
JudpSettingsInterface::BroadcastMethod broadcastMethod
 
std::string multicastAddress
 
bool ackNakEnabled
 
int ackNakTimeout_ms
 
uint16 timeToLive
 
int ackNakRetryCount
 
JudpSettingsInterface::UnknownRouteResolutionMethod::Enum unknownRouteResolutionMethod
 
uint64 maxQueueSize
 

Additional Inherited Members

- Public Types inherited from openjaus::transport::AS5669::JudpSettingsInterface
enum  BroadcastMethod { BROADCAST_IP, MULTICAST, BOTH }
 

Constructor & Destructor Documentation

◆ JudpSettings()

openjaus::transport::AS5669::JudpSettings::JudpSettings ( )

◆ ~JudpSettings()

openjaus::transport::AS5669::JudpSettings::~JudpSettings ( )
virtual

Member Function Documentation

◆ areValid()

bool openjaus::transport::AS5669::JudpSettings::areValid ( )

◆ enableAckNak()

void openjaus::transport::AS5669::JudpSettings::enableAckNak ( bool  value)

◆ enableMulticastDiscovery()

void openjaus::transport::AS5669::JudpSettings::enableMulticastDiscovery ( bool  value)

◆ getAckNakTimeout_ms()

int openjaus::transport::AS5669::JudpSettings::getAckNakTimeout_ms ( )
virtual

◆ getBroadcastMethod()

JudpSettingsInterface::BroadcastMethod openjaus::transport::AS5669::JudpSettings::getBroadcastMethod ( )
virtual

◆ getLargeMessageBurstLength()

int openjaus::transport::AS5669::JudpSettings::getLargeMessageBurstLength ( )
virtual

◆ getMaxAckNakRetries()

int openjaus::transport::AS5669::JudpSettings::getMaxAckNakRetries ( )
virtual

◆ getMaxQueueSize()

uint32 openjaus::transport::AS5669::JudpSettings::getMaxQueueSize ( )
virtual

◆ getMulticastAddress()

std::string openjaus::transport::AS5669::JudpSettings::getMulticastAddress ( )
virtual

◆ getPrimaryPort()

short openjaus::transport::AS5669::JudpSettings::getPrimaryPort ( )
virtual

◆ getSecondaryPort()

short openjaus::transport::AS5669::JudpSettings::getSecondaryPort ( )
virtual

◆ getTimeToLive()

uint8 openjaus::transport::AS5669::JudpSettings::getTimeToLive ( )
virtual

◆ getUnknownRouteResolutionMethod()

JudpSettingsInterface::UnknownRouteResolutionMethod::Enum openjaus::transport::AS5669::JudpSettings::getUnknownRouteResolutionMethod ( ) const
virtual

◆ isAckNakEnabled()

bool openjaus::transport::AS5669::JudpSettings::isAckNakEnabled ( )
virtual

◆ isLargeMessageBurstSendEnabled()

bool openjaus::transport::AS5669::JudpSettings::isLargeMessageBurstSendEnabled ( )
virtual

◆ isMulticastDiscoveryEnabled()

bool openjaus::transport::AS5669::JudpSettings::isMulticastDiscoveryEnabled ( )
virtual

◆ loadBroadcastMethod()

JudpSettings::BroadcastMethod openjaus::transport::AS5669::JudpSettings::loadBroadcastMethod ( )
staticprivate

◆ loadFromConfFile()

JudpSettings * openjaus::transport::AS5669::JudpSettings::loadFromConfFile ( const std::string &  componentName)
static

◆ loadUnknownRouteResolutionMethod()

JudpSettingsInterface::UnknownRouteResolutionMethod::Enum openjaus::transport::AS5669::JudpSettings::loadUnknownRouteResolutionMethod ( )
staticprivate

◆ setAckNakTimeout_ms()

void openjaus::transport::AS5669::JudpSettings::setAckNakTimeout_ms ( int  value)

◆ setBroadcastMethod()

void openjaus::transport::AS5669::JudpSettings::setBroadcastMethod ( JudpSettingsInterface::BroadcastMethod  value)

◆ setInterfaceSettings()

void openjaus::transport::AS5669::JudpSettings::setInterfaceSettings ( InterfaceSettings settings)
private

◆ setLargeMessageBurstLength()

void openjaus::transport::AS5669::JudpSettings::setLargeMessageBurstLength ( int  value)
virtual

◆ setMaxAckNakRetries()

void openjaus::transport::AS5669::JudpSettings::setMaxAckNakRetries ( int  value)

◆ setMulticastAddress()

void openjaus::transport::AS5669::JudpSettings::setMulticastAddress ( std::string  value)

◆ setPrimaryPort()

void openjaus::transport::AS5669::JudpSettings::setPrimaryPort ( short  value)

◆ setSecondaryPort()

void openjaus::transport::AS5669::JudpSettings::setSecondaryPort ( short  value)

◆ setTimeToLive()

void openjaus::transport::AS5669::JudpSettings::setTimeToLive ( uint8  value)

◆ setUnknownRouteResolutionMethod()

void openjaus::transport::AS5669::JudpSettings::setUnknownRouteResolutionMethod ( JudpSettingsInterface::UnknownRouteResolutionMethod::Enum  value)
virtual

◆ verifySettingsAndThrowIfError()

void openjaus::transport::AS5669::JudpSettings::verifySettingsAndThrowIfError ( JudpSettings settings)
staticprivate

Member Data Documentation

◆ ackNakEnabled

bool openjaus::transport::AS5669::JudpSettings::ackNakEnabled
private

◆ ackNakRetryCount

int openjaus::transport::AS5669::JudpSettings::ackNakRetryCount
private

◆ ackNakTimeout_ms

int openjaus::transport::AS5669::JudpSettings::ackNakTimeout_ms
private

◆ broadcastMethod

JudpSettingsInterface::BroadcastMethod openjaus::transport::AS5669::JudpSettings::broadcastMethod
private

◆ interfaceSettings

InterfaceSettings* openjaus::transport::AS5669::JudpSettings::interfaceSettings
private

◆ maxQueueSize

uint64 openjaus::transport::AS5669::JudpSettings::maxQueueSize
private

◆ multicastAddress

std::string openjaus::transport::AS5669::JudpSettings::multicastAddress
private

◆ multicastDiscoveryEnabled

bool openjaus::transport::AS5669::JudpSettings::multicastDiscoveryEnabled
private

◆ primaryPort

short openjaus::transport::AS5669::JudpSettings::primaryPort
private

◆ secondaryPort

short openjaus::transport::AS5669::JudpSettings::secondaryPort
private

◆ timeToLive

uint16 openjaus::transport::AS5669::JudpSettings::timeToLive
private

◆ unknownRouteResolutionMethod

JudpSettingsInterface::UnknownRouteResolutionMethod::Enum openjaus::transport::AS5669::JudpSettings::unknownRouteResolutionMethod
private

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