Package: android.hardware.wifi.supplicant@1.0

ISupplicant

interface ISupplicant

Interface exposed by the supplicant HIDL service registered with the hardware service manager.This is the root level object for any the supplicant interactions.

Properties

DebugLevel

enum DebugLevel: uint32_t

Debug levels for the supplicant.Only log messages with a level greater than the set level(via |setDebugParams|)will be logged.

Details
Members
EXCESSIVE = 0
MSGDUMP = 1
DEBUG = 2
INFO = 3
WARNING = 4
ERROR = 5

IfaceInfo

struct IfaceInfo {IfaceType type; string name}

Structure describing the type and name of an iface controlled by the supplicant.

Details
Members
type
Type of the network interface.
name
Name of the network interface, e.g ., wlan0

Methods

getInterface

getInterface (IfaceInfo ifaceInfo)
generates (SupplicantStatus status, ISupplicantIface iface)

Gets a HIDL interface object for the interface corresponding to iface name which the supplicant already controls.

Details
Parameters
ifaceInfo
Combination of the iface type and name retrieved using |listInterfaces|.
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_IFACE_UNKOWN|
iface
HIDL interface object representing the interface if successful, null otherwise.

listInterfaces

listInterfaces ()
generates (SupplicantStatus status, vec<IfaceInfo> ifaces)

Retrieve a list of all the interfaces controlled by the supplicant.

The corresponding |ISupplicantIface| object for any interface can be retrieved using |getInterface| method.

Details
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_UNKNOWN|
ifaces
List of all interfaces controlled by the supplicant.

registerCallback

registerCallback (ISupplicantCallback callback)
generates (SupplicantStatus status)

Register for callbacks from the supplicant service.

These callbacks are invoked for global events that are not specific to any interface or network.Registration of multiple callback objects is supported.These objects must be deleted when the corresponding client process is dead.

Details
Parameters
callback
An instance of the |ISupplicantCallback| HIDL interface object.
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_UNKNOWN|

setDebugParams

setDebugParams (DebugLevel level, bool showTimestamp, bool showKeys)
generates (SupplicantStatus status)

Set debug parameters for the supplicant.

Details
Parameters
level
Debug logging level for the supplicant .(one of |DebugLevel| values).
showTimestamp
Determines whether to show timestamps in logs or not.
showKeys
Determines whether to show keys in debug logs or not.CAUTION:Do not set this param in production code!
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_UNKNOWN|

getDebugLevel

getDebugLevel ()
generates (DebugLevel level)

Get the debug level set.

Details
Generates
level
one of |DebugLevel| values.

isDebugShowTimestampEnabled

isDebugShowTimestampEnabled ()
generates (bool enabled)

Get whether the timestamps are shown in the debug logs or not.

Details
Generates
enabled
true if set, false otherwise.

isDebugShowKeysEnabled

isDebugShowKeysEnabled ()
generates (bool enabled)

Get whether the keys are shown in the debug logs or not.

Details
Generates
enabled
true if set, false otherwise.

setConcurrencyPriority

setConcurrencyPriority (IfaceType type)
generates (SupplicantStatus status)

Set concurrency priority.

When both P2P and STA mode ifaces are active, this must be used to prioritize either STA or P2P connection to resolve conflicts arising during single channel concurrency.

Details
Parameters
type
The type of iface to prioritize.
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_UNKNOWN|