class WifiInformation

August 13, 2019 ยท View on GitHub

Member values

Member nameData typeDescription
ssidSsidSSID
security_typeuint32Wi-Fi security type
encryption_typeuint32Wi-Fi encryption type
signal_qualityuint32Wi-Fi signal quality
signal_strengthint32Wi-Fi signal power in dBm
frequencyuint32Wi-Fi operating frequency (channel) in MHz
channeluint32Wi-Fi operating channel

Member functions

Function nameReturn typeInput typeDescription
has_ssid() constboolvoidReturns true if ssid is set.
ssid()const Ssid&voidReturns the current value of ssid. If ssid is not set, returns a Ssid with none of its fields set (possibly ssid::default_instance()).
mutable_ssid()Ssid *voidReturns a pointer to the mutable Ssid object that stores the field's value. If the field was not set prior to the call, then the returned Ssid will have none of its fields set (i.e. it will be identical to a newly-allocated Ssid). After calling this, has_ssid() will return true and ssid() will return a reference to the same instance of Ssid.
clear_ssid()voidvoidClears the value of the field. After calling this, has_ssid() will return false and ssid() will return the default value.
set_allocated_ssid()voidSsid *Sets the Ssid object to the field and frees the previous field value if it exists. If the Ssid pointer is not NULL, the message takes ownership of the allocated Ssid object and has_ Ssid() will return true. Otherwise, if the ssid is NULL, the behavior is the same as calling clear_ssid().
release_ssid()Ssid *voidReleases the ownership of the field and returns the pointer of the Ssid object. After calling this, caller takes the ownership of the allocated Ssid object, has_ssid() will return false, and ssid() will return the default value.
security_type()uint32voidReturns the current value of security_type. If the security_type is not set, returns 0.
set_security_type()voiduint32Sets the value of security_type. After calling this, security_type() will return value.
clear_security_type()voidvoidClears the value of security_type. After calling this, security_type() will return 0.
encryption_type()uint32voidReturns the current value of encryption_type. If the encryption_type is not set, returns 0.
set_encryption_type()voiduint32Sets the value of encryption_type. After calling this, encryption_type() will return value.
clear_encryption_type()voidvoidClears the value of encryption_type. After calling this, encryption_type() will return 0.
signal_quality() constuint32voidReturns the current value of signal_quality. If the signal_quality is not set, returns 0.
set_signal_quality()voiduint32Sets the value of signal_quality. After calling this, signal_quality() will return value.
clear_signal_quality()voidvoidClears the value of signal_quality. After calling this, signal_quality() will return the empty string/empty bytes.
signal_strength()int32voidReturns the current value of signal_strength. If the signal_strength is not set, returns 0.
set_signal_strength()voidint32Sets the value of signal_strength. After calling this, signal_strength() will return value.
clear_signal_strength()voidvoidClears the value of signal_strength. After calling this, signal_strength() will return 0.
frequency()uint32voidReturns the current value of frequency. If the frequency is not set, returns 0.
set_frequency()voiduint32Sets the value of frequency. After calling this, frequency() will return value.
clear_frequency()voidvoidClears the value of frequency. After calling this, frequency() will return 0.
channel()uint32voidReturns the current value of channel. If the channel is not set, returns 0.
set_channel()voiduint32Sets the value of channel. After calling this, channel() will return value.
clear_channel()voidvoidClears the value of channel. After calling this, channel() will return 0.

Parent topic: Base (C++)