SleelaDoc API
HTML documentation for the SLeeLa standard library (/lib)
Home › Packages › wifi

Package wifi

This package contains 17 source unit(s) defining 17 class(es) / struct(s). Each unit below lists its fields (the values it stores) and methods (the actions it performs), with a plain explanation of each.

SLWifi4Manager #sleela 2.5 (lib/wifi/SLWifi4Manager.sleela)

SLWifi4Manager class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
modelWifi4Model modelNo description in source.
managerSLWifiManager managerNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
configurevoid configure()No description in source.
generationString generation()No description in source.
standardString standard()No description in source.
supportsChannelWidthboolean supportsChannelWidth(int widthMHz)No description in source.
supportsSpatialStreamsboolean supportsSpatialStreams(int streams)No description in source.
needsRuntimeDiscoveryboolean needsRuntimeDiscovery()No description in source.
wifiManagerSLWifiManager wifiManager()No description in source.

SLWifi5Manager #sleela 2.5 (lib/wifi/SLWifi5Manager.sleela)

SLWifi5Manager class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
modelWifi5Model modelNo description in source.
managerSLWifiManager managerNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
configurevoid configure()No description in source.
generationString generation()No description in source.
standardString standard()No description in source.
supportsChannelWidthboolean supportsChannelWidth(int widthMHz)No description in source.
supportsSpatialStreamsboolean supportsSpatialStreams(int streams)No description in source.
needsRuntimeDiscoveryboolean needsRuntimeDiscovery()No description in source.
wifiManagerSLWifiManager wifiManager()No description in source.

SLWifi6Manager #sleela 2.5 (lib/wifi/SLWifi6Manager.sleela)

SLWifi6Manager class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
modelWifi6Model modelNo description in source.
managerSLWifiManager managerNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
configurevoid configure()No description in source.
generationString generation()No description in source.
standardString standard()No description in source.
supportsChannelWidthboolean supportsChannelWidth(int widthMHz)No description in source.
supportsSpatialStreamsboolean supportsSpatialStreams(int streams)No description in source.
needsRuntimeDiscoveryboolean needsRuntimeDiscovery()No description in source.
allows6GHzAsGenericWifi6boolean allows6GHzAsGenericWifi6()No description in source.
wifiManagerSLWifiManager wifiManager()No description in source.

SLWifiCredentials #sleela 2.5 (lib/wifi/SLWifiCredentials.sleela)

SLWifiCredentials class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
OS_MANAGEDstatic final int OS_MANAGED = 0No description in source.
SAVED_PROFILEstatic final int SAVED_PROFILE = 1No description in source.
PASSPHRASEstatic final int PASSPHRASE = 2No description in source.
ENTERPRISE_PASSWORDstatic final int ENTERPRISE_PASSWORD = 3No description in source.
modeint modeNo description in source.
profileNameString profileNameNo description in source.
usernameString usernameNo description in source.
passwordString passwordNo description in source.
caCertificateFileString caCertificateFileNo description in source.
expectedServerNameString expectedServerNameNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
configureOSManagedvoid configureOSManaged()No description in source.
configureSavedProfilevoid configureSavedProfile(String name)No description in source.
configurePassphrasevoid configurePassphrase(String passphrase)No description in source.
configureEnterprisevoid configureEnterprise(String user, String secret, String caFile, String serverName)No description in source.
isValidboolean isValid()No description in source.
clearFieldsvoid clearFields()No description in source.
clearvoid clear()No description in source.
prefersOSAuthenticationboolean prefersOSAuthentication()No description in source.

SLWifiManager #sleela 2.5 (lib/wifi/SLWifiManager.sleela)

SLWifiManager class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
STATE_NEWstatic final int STATE_NEW = 0No description in source.
STATE_BRIDGE_READYstatic final int STATE_BRIDGE_READY = 1No description in source.
STATE_SCANNINGstatic final int STATE_SCANNING = 2No description in source.
STATE_SCANNEDstatic final int STATE_SCANNED = 3No description in source.
STATE_CONNECTINGstatic final int STATE_CONNECTING = 4No description in source.
STATE_CONNECTEDstatic final int STATE_CONNECTED = 5No description in source.
STATE_DISCONNECTEDstatic final int STATE_DISCONNECTED = 6No description in source.
STATE_FAILEDstatic final int STATE_FAILED = 7No description in source.
STATE_DISCONNECTINGstatic final int STATE_DISCONNECTING = 8No description in source.
nativeHandleint nativeHandleNo description in source.
stateint stateNo description in source.
lastStatusint lastStatusNo description in source.
lastScanCountint lastScanCountNo description in source.
selectedNetworkSLWifiNetwork selectedNetworkNo description in source.
policySLWifiSecurityPolicy policyNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
configurevoid configure()No description in source.
bindNativeHandleboolean bindNativeHandle(int handle)No description in source.
nativeReadyboolean nativeReady()No description in source.
handleint handle()No description in source.
managerStateint managerState()No description in source.
statusint status()No description in source.
scanCountint scanCount()No description in source.
securityPolicySLWifiSecurityPolicy securityPolicy()No description in source.
beginScanRequestint beginScanRequest()No description in source.
acceptScanResultint acceptScanResult(int statusCode, int count)No description in source.
selectNetworkboolean selectNetwork(SLWifiNetwork network)No description in source.
authorizeConnectionint authorizeConnection(SLWifiCredentials credentials)No description in source.
beginConnectRequestint beginConnectRequest(SLWifiCredentials credentials)No description in source.
acceptConnectionResultint acceptConnectionResult(int statusCode)No description in source.
beginDisconnectRequestint beginDisconnectRequest()No description in source.
acceptDisconnectResultint acceptDisconnectResult(int statusCode)No description in source.
clearCredentialsvoid clearCredentials(SLWifiCredentials credentials)No description in source.
resetvoid reset()No description in source.

SLWifiNetwork #sleela 2.5 (lib/wifi/SLWifiNetwork.sleela)

SLWifiNetwork class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
ssidString ssidNo description in source.
bssidString bssidNo description in source.
channelint channelNo description in source.
frequencyMHzint frequencyMHzNo description in source.
signalPercentint signalPercentNo description in source.
securityint securityNo description in source.
inUseint inUseNo description in source.
protectedManagementFramesint protectedManagementFramesNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
configurevoid configure(String networkSsid, String accessPointBssid, int channelNumber,No description in source.
hasIdentityboolean hasIdentity()No description in source.
signalIsValidboolean signalIsValid()No description in source.
pmfIsKnownboolean pmfIsKnown()No description in source.
pmfIsEnabledboolean pmfIsEnabled()No description in source.
connectedboolean connected()No description in source.
networkNameString networkName()No description in source.
accessPointAddressString accessPointAddress()No description in source.
securityKindint securityKind()No description in source.
signalStrengthPercentint signalStrengthPercent()No description in source.
channelNumberint channelNumber()No description in source.
frequencyInMHzint frequencyInMHz()No description in source.

SLWifiOOD #sleela 2.5 (lib/wifi/SLWifiOOD.sleela)

SLWifiOOD class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
titleString titleNo description in source.
managerSLWifiManager managerNo description in source.
visibleint visibleNo description in source.
selectedIndexint selectedIndexNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
configurevoid configure(String panelTitle)No description in source.
openvoid open()No description in source.
closevoid close()No description in source.
isVisibleboolean isVisible()No description in source.
panelTitleString panelTitle()No description in source.
wifiManagerSLWifiManager wifiManager()No description in source.
beginRefreshint beginRefresh()No description in source.
disconnectint disconnect()No description in source.
chooseNetworkboolean chooseNetwork(int index, SLWifiNetwork network)No description in source.
selectedNetworkIndexint selectedNetworkIndex()No description in source.
resetSelectionvoid resetSelection()No description in source.

SLWifiSecurity #sleela 2.5 (lib/wifi/SLWifiSecurity.sleela)

SLWifiSecurity class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
UNKNOWNstatic final int UNKNOWN = 0No description in source.
OPENstatic final int OPEN = 1No description in source.
WEPstatic final int WEP = 2No description in source.
WPA_PERSONALstatic final int WPA_PERSONAL = 3No description in source.
WPA2_PERSONALstatic final int WPA2_PERSONAL = 4No description in source.
WPA3_PERSONALstatic final int WPA3_PERSONAL = 5No description in source.
OWEstatic final int OWE = 6No description in source.
WPA_ENTERPRISEstatic final int WPA_ENTERPRISE = 7No description in source.
WPA2_ENTERPRISEstatic final int WPA2_ENTERPRISE = 8No description in source.
WPA3_ENTERPRISEstatic final int WPA3_ENTERPRISE = 9No description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
rankint rank(int security)No description in source.
nameString name(int security)No description in source.
isEnterpriseboolean isEnterprise(int security)No description in source.
isPersonalboolean isPersonal(int security)No description in source.
isLegacyboolean isLegacy(int security)No description in source.

SLWifiSecurityPolicy #sleela 2.5 (lib/wifi/SLWifiSecurityPolicy.sleela)

SLWifiSecurityPolicy class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
DEFAULT_MINIMUM_SECURITY_RANKstatic final int DEFAULT_MINIMUM_SECURITY_RANK = 4No description in source.
minimumSecurityRankint minimumSecurityRankNo description in source.
allowOpenNetworksint allowOpenNetworksNo description in source.
allowLegacyWepint allowLegacyWepNo description in source.
requireEnterpriseTlsValidationint requireEnterpriseTlsValidationNo description in source.
requireProtectedManagementFramesint requireProtectedManagementFramesNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
configureDefaultsvoid configureDefaults()No description in source.
validboolean valid()No description in source.
binaryValueboolean binaryValue(int value)No description in source.
allowsboolean allows(int security)No description in source.
allowsNetworkboolean allowsNetwork(SLWifiNetwork network)No description in source.
setMinimumSecurityRankvoid setMinimumSecurityRank(int rank)No description in source.

SLWifiStatus #sleela 2.5 (lib/wifi/SLWifiStatus.sleela)

SLWifiStatus class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
OKstatic final int OK = 0No description in source.
INVALID_ARGUMENTstatic final int INVALID_ARGUMENT = 1No description in source.
BACKEND_UNAVAILABLEstatic final int BACKEND_UNAVAILABLE = 2No description in source.
BACKEND_ERRORstatic final int BACKEND_ERROR = 3No description in source.
BUFFER_TOO_SMALLstatic final int BUFFER_TOO_SMALL = 4No description in source.
NETWORK_NOT_FOUNDstatic final int NETWORK_NOT_FOUND = 5No description in source.
POLICY_BLOCKEDstatic final int POLICY_BLOCKED = 6No description in source.
AUTH_REQUIREDstatic final int AUTH_REQUIRED = 7No description in source.
NOT_CONNECTEDstatic final int NOT_CONNECTED = 8No description in source.
BRIDGE_REQUIREDstatic final int BRIDGE_REQUIRED = 9No description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
nameString name(int code)No description in source.
succeededboolean succeeded(int code)No description in source.
failedboolean failed(int code)No description in source.

ValidateWifi4 #sleela 2.5 (lib/wifi/4/examples/ValidateWifi4.sleela)

No class declaration parsed.

ValidateWifi5 #sleela 2.5 (lib/wifi/5/examples/ValidateWifi5.sleela)

No class declaration parsed.

ValidateWifi6 #sleela 2.5 (lib/wifi/6/examples/ValidateWifi6.sleela)

No class declaration parsed.

Wifi4Model #sleela 2.5 (lib/wifi/4/Wifi4Model.sleela)

Wifi4Profile struct

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
generationString generationNo description in source.
ieeeString ieeeNo description in source.
supports24GHzint supports24GHzNo description in source.
supports5GHzint supports5GHzNo description in source.
maxChannelWidthMHzint maxChannelWidthMHzNo description in source.
maxSpatialStreamsint maxSpatialStreamsNo description in source.
maxQamOrderint maxQamOrderNo description in source.
theoreticalPeakMbpsint theoreticalPeakMbpsNo description in source.
requiresRuntimeCapabilityDiscoveryint requiresRuntimeCapabilityDiscoveryNo description in source.

Wifi4Model class

Methods — the actions this unit can perform.

MethodSignatureWhat it does
standardProfileWifi4Profile standardProfile()No description in source.
isValidChannelWidthint isValidChannelWidth(int widthMHz)No description in source.
isValidSpatialStreamCountint isValidSpatialStreamCount(int streams)No description in source.
needsRuntimeDiscoveryint needsRuntimeDiscovery()No description in source.

Wifi5Model #sleela 2.5 (lib/wifi/5/Wifi5Model.sleela)

Wifi5Profile struct

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
generationString generationNo description in source.
ieeeString ieeeNo description in source.
supports24GHzint supports24GHzNo description in source.
supports5GHzint supports5GHzNo description in source.
maxChannelWidthMHzint maxChannelWidthMHzNo description in source.
maxSpatialStreamsint maxSpatialStreamsNo description in source.
maxQamOrderint maxQamOrderNo description in source.
theoreticalPeakMbpsint theoreticalPeakMbpsNo description in source.
requiresRuntimeCapabilityDiscoveryint requiresRuntimeCapabilityDiscoveryNo description in source.

Wifi5Model class

Methods — the actions this unit can perform.

MethodSignatureWhat it does
standardProfileWifi5Profile standardProfile()No description in source.
isValidChannelWidthint isValidChannelWidth(int widthMHz)No description in source.
isValidSpatialStreamCountint isValidSpatialStreamCount(int streams)No description in source.
needsRuntimeDiscoveryint needsRuntimeDiscovery()No description in source.

Wifi6Model #sleela 2.5 (lib/wifi/6/Wifi6Model.sleela)

Wifi6Profile struct

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
generationString generationNo description in source.
ieeeString ieeeNo description in source.
supports24GHzint supports24GHzNo description in source.
supports5GHzint supports5GHzNo description in source.
supports6GHzByDefaultint supports6GHzByDefaultNo description in source.
maxChannelWidthMHzint maxChannelWidthMHzNo description in source.
maxSpatialStreamsint maxSpatialStreamsNo description in source.
maxQamOrderint maxQamOrderNo description in source.
theoreticalPeakMbpsint theoreticalPeakMbpsNo description in source.
supportsOfdmaint supportsOfdmaNo description in source.
supportsMuMimoint supportsMuMimoNo description in source.
supportsBssColoringint supportsBssColoringNo description in source.
supportsTargetWakeTimeint supportsTargetWakeTimeNo description in source.
requiresRuntimeCapabilityDiscoveryint requiresRuntimeCapabilityDiscoveryNo description in source.

Wifi6Model class

Methods — the actions this unit can perform.

MethodSignatureWhat it does
standardProfileWifi6Profile standardProfile()No description in source.
isValidChannelWidthint isValidChannelWidth(int widthMHz)No description in source.
isValidSpatialStreamCountint isValidSpatialStreamCount(int streams)No description in source.
needsRuntimeDiscoveryint needsRuntimeDiscovery()No description in source.
allows6GHzAsGenericWifi6int allows6GHzAsGenericWifi6()No description in source.

WifiOODPolicySmoke #sleela 2.5 (lib/wifi/examples/WifiOODPolicySmoke.sleela)

WifiOODPolicySmoke class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
runint run()No description in source.