NTRIPConnectionConfig Struct Reference

#include <NTRIPConfiguration.h>

Public Member Functions
bool	operator== (const NTRIPConnectionConfig &) const =default
QString	validationError () const
QString	streamValidationError () const
QUrl	url (bool withMountpoint=true) const
	The caster's HTTP(S) URL, with the mountpoint as its path when withMountpoint is set, else "/".
bool	sendsCredentialsInClear () const
	Credentials go to the caster without TLS.
QString	credentialsInClearWarning () const
	The user-visible warning when credentials go to the caster without TLS; empty otherwise.

Public Attributes
QString	host
int	port = 2101
QString	username
QString	password
QString	mountpoint
bool	useTls = false
bool	allowSelfSignedCerts = false
QString	pinnedCertificate
	"host:port|sha256-hex" of the self-signed certificate trusted on first use; other endpoints ignore it.

Detailed Description

Definition at line 6 of file NTRIPConfiguration.h.

Member Function Documentation

credentialsInClearWarning()

QString NTRIPConnectionConfig::credentialsInClearWarning

(

)

const

The user-visible warning when credentials go to the caster without TLS; empty otherwise.

Definition at line 66 of file NTRIPConfiguration.cc.

References sendsCredentialsInClear().

Referenced by NTRIPManager::securityWarning(), and NTRIPSourceTableController::securityWarning().

operator==()

bool NTRIPConnectionConfig::operator== ( const NTRIPConnectionConfig &  ) const

default

sendsCredentialsInClear()

bool NTRIPConnectionConfig::sendsCredentialsInClear

(

)

const

Credentials go to the caster without TLS.

Definition at line 61 of file NTRIPConfiguration.cc.

References password, username, and useTls.

Referenced by credentialsInClearWarning(), and NTRIPHttpTransport::start().

streamValidationError()

QString NTRIPConnectionConfig::streamValidationError

(

)

const

Definition at line 40 of file NTRIPConfiguration.cc.

References error, mountpoint, and validationError().

url()

QUrl NTRIPConnectionConfig::url

(

bool

withMountpoint = true

)

const

The caster's HTTP(S) URL, with the mountpoint as its path when withMountpoint is set, else "/".

Definition at line 51 of file NTRIPConfiguration.cc.

References host, mountpoint, port, url(), and useTls.

Referenced by url().

validationError()

QString NTRIPConnectionConfig::validationError

(

)

const

Definition at line 8 of file NTRIPConfiguration.cc.

References host, mountpoint, and username.

Referenced by NTRIPSourceTableController::fetch(), and streamValidationError().

Member Data Documentation

allowSelfSignedCerts

bool NTRIPConnectionConfig::allowSelfSignedCerts = false

Definition at line 14 of file NTRIPConfiguration.h.

Referenced by NTRIPManager::setConfiguration().

host

QString NTRIPConnectionConfig::host

Definition at line 8 of file NTRIPConfiguration.h.

Referenced by url(), and validationError().

mountpoint

QString NTRIPConnectionConfig::mountpoint

Definition at line 12 of file NTRIPConfiguration.h.

Referenced by NTRIPHttpTransport::start(), streamValidationError(), url(), and validationError().

password

QString NTRIPConnectionConfig::password

Definition at line 11 of file NTRIPConfiguration.h.

Referenced by sendsCredentialsInClear().

pinnedCertificate

QString NTRIPConnectionConfig::pinnedCertificate

"host:port|sha256-hex" of the self-signed certificate trusted on first use; other endpoints ignore it.

Definition at line 16 of file NTRIPConfiguration.h.

Referenced by NTRIPManager::setConfiguration().

port

int NTRIPConnectionConfig::port = 2101

Definition at line 9 of file NTRIPConfiguration.h.

Referenced by url().

username

QString NTRIPConnectionConfig::username

Definition at line 10 of file NTRIPConfiguration.h.

Referenced by sendsCredentialsInClear(), and validationError().

useTls

bool NTRIPConnectionConfig::useTls = false

Definition at line 13 of file NTRIPConfiguration.h.

Referenced by sendsCredentialsInClear(), and url().

---

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

• src/GPS/NTRIP/HTTP/NTRIPConfiguration.h
• src/GPS/NTRIP/HTTP/NTRIPConfiguration.cc