3
0
mirror of https://git.kernel.org/pub/scm/network/wireless/iwd.git synced 2024-11-25 17:49:37 +01:00
iwd/doc/agent-api.txt
2019-10-28 11:32:23 -05:00

85 lines
2.3 KiB
Plaintext

Agent Manager hierarchy
=======================
Service net.connman.iwd
Interface net.connman.iwd.AgentManager
Object path /net/connman/iwd
Methods void RegisterAgent(object path)
Register new agent for handling user requests.
Possible Errors: [service].Error.InvalidArguments
[service].Error.Failed
[service].Error.AlreadyExists
void UnregisterAgent(object path)
Unregister an existing agent.
Possible Errors: [service].Error.InvalidArguments
[service].Error.Failed
[service].Error.NotFound
Agent hierarchy
===============
Service unique name
Interface net.connman.iwd.Agent
Object path freely definable
Methods void Release()
This method gets called when the service daemon
unregisters the agent. An agent can use it to do
cleanup tasks. There is no need to unregister the
agent, because when this method gets called it has
already been unregistered.
string RequestPassphrase(object network)
This method gets called when trying to connect to
a network and passphrase is required.
Possible Errors: net.connman.iwd.Agent.Error.Canceled
string RequestPrivateKeyPassphrase(object network)
This method gets called when connecting to
a network that requires authentication using a
locally-stored encrypted private key file, to
obtain that private key's encryption passphrase.
Possible Errors: net.connman.iwd.Agent.Error.Canceled
(string, string) RequestUserNameAndPassword(object network)
This method gets called when connecting to
a network that requires authentication using a
user name and password.
Possible Errors: net.connman.iwd.Agent.Error.Canceled
string RequestUserPassword(object network, string user)
This method gets called when connecting to
a network that requires authentication with a
user password. The user name is optionally passed
in the parameter.
Possible Errors: net.connman.iwd.Agent.Error.Canceled
void Cancel(string reason)
This method gets called to indicate that the agent
request failed before a reply was returned. The
argument will indicate why the request is being
cancelled and may be "out-of-range", "user-canceled",
"timed-out" or "shutdown".
Examples Requesting a passphrase for WPA2 network
RequestPassphrase("/network1")
==> "secret123"