3
0
mirror of https://git.kernel.org/pub/scm/network/wireless/iwd.git synced 2024-11-25 09:39:25 +01:00

doc: Update agent-api.txt to match code and clarify

This commit is contained in:
Andrew Zaborowski 2021-10-21 10:50:38 +02:00 committed by Denis Kenzior
parent e782911d33
commit 04773eaa2c

View File

@ -7,19 +7,23 @@ Object path /net/connman/iwd
Methods void RegisterAgent(object path) Methods void RegisterAgent(object path)
Register new agent for handling user requests. Register new agent for handling user secrets requests.
The agent object's methods on the net.connman.iwd.Agent
interface will be called when IWD needs to request
credentials for a connection to a network in station
mode.
Possible Errors: [service].Error.InvalidArguments Possible Errors: [service].InvalidArguments
[service].Error.Failed [service].Failed
[service].Error.AlreadyExists [service].AlreadyExists
void UnregisterAgent(object path) void UnregisterAgent(object path)
Unregister an existing agent. Unregister an existing agent.
Possible Errors: [service].Error.InvalidArguments Possible Errors: [service].InvalidArguments
[service].Error.Failed [service].Failed
[service].Error.NotFound [service].NotFound
Agent hierarchy Agent hierarchy
@ -80,5 +84,5 @@ Methods void Release() [noreply]
Examples Requesting a passphrase for WPA2 network Examples Requesting a passphrase for WPA2 network
RequestPassphrase("/network1") RequestPassphrase("/net/connman/iwd/0/3/54657374_psk")
==> "secret123" ==> "secret123"