[PATCH] Connman : Add group api doc
Shailesh Rathod/LGSI Connectivity Team <[email protected]> Mon, 6 Oct 2025 08:56:56 +0000
| Newsgroups | dev.linux.lists.connman |
|---|---|
| Message-ID | <SE1P216MB264750A28C4AC70F93921235F0E3A@SE1P216MB2647.KORP216.PROD.OUTLOOK.COM> |
From 35d0aa17db4a852a76692fb550996d81b317606a Mon Sep 17 00:00:00 2001=0A= From: shailesh <[email protected]>=0A= Date: Mon, 6 Oct 2025 08:25:47 +0000=0A= Subject: [PATCH] Add group api doc=0A= ---=0A= =A0doc/group-api.txt | 80 +++++++++++++++++++++++++++++++++++++++++++++++= =0A= =A01 file changed, 80 insertions(+)=0A= =A0create mode 100644 doc/group-api.txt=0A= =0A= diff --git a/doc/group-api.txt b/doc/group-api.txt=0A= new file mode 100644=0A= index 0000000..94a7caf=0A= --- /dev/null=0A= +++ b/doc/group-api.txt=0A= @@ -0,0 +1,80 @@=0A= +Group hierarchy=0A= +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=0A= +=0A= +Service =A0 =A0 =A0 =A0net.connman=0A= +Interface =A0net.connman.Group=0A= +Object path =A0 =A0/net/connman/group/<identifier>=0A= +=0A= +Methods=0A= +=0A= + =A0 =A0dict GetProperties() =A0 [deprecated]=0A= +=0A= + =A0 =A0 =A0 =A0Returns all group properties as a dictionary.=0A= + =A0 =A0 =A0 =A0Properties include Name, Owner, Passphrase, Persistent, Te= thering, Freq, etc.=0A= +=0A= + =A0 =A0 =A0 =A0Possible Errors: net.connman.Error.InvalidArguments=0A= +=0A= + =A0 =A0void SetProperty(string name, variant value)=0A= +=0A= + =A0 =A0 =A0 =A0Sets the value of the specified property for the group.=0A= + =A0 =A0 =A0 =A0Currently supported property: "Tethering" (boolean).=0A= +=0A= + =A0 =A0 =A0 =A0Possible Errors: net.connman.Error.InvalidArguments=0A= + =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 net.connman.Error.AlreadyEnabled=0A= + =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 net.connman.Error.AlreadyDisabled=0A= + =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 net.connman.Error.Failed=0A= +=0A= + =A0 =A0void Disconnect()=0A= +=0A= + =A0 =A0 =A0 =A0Disconnects the group from the current P2P session.=0A= +=0A= + =A0 =A0 =A0 =A0Possible Errors: net.connman.Error.Failed=0A= +=0A= + =A0 =A0void Invite(string service_path)=0A= +=0A= + =A0 =A0 =A0 =A0Invites a peer (specified by its service object path) to j= oin the group.=0A= +=0A= + =A0 =A0 =A0 =A0Possible Errors: net.connman.Error.InvalidArguments=0A= +=0A= + =A0 =A0array{object,dict} GetPeers()=0A= +=0A= + =A0 =A0 =A0 =A0Returns a list of tuples with peer object path and diction= ary of peer properties.=0A= +=0A= + =A0 =A0 =A0 =A0Possible Errors: net.connman.Error.InvalidArguments=0A= +=0A= +Signals=0A= +=0A= + =A0 =A0PropertyChanged(string name, variant value)=0A= +=0A= + =A0 =A0 =A0 =A0Indicates a changed value of the given property.=0A= +=0A= + =A0 =A0PeerAdded(object path)=0A= +=0A= + =A0 =A0 =A0 =A0Indicates that a new peer has joined the group.=0A= +=0A= + =A0 =A0PeerRemoved(object path)=0A= +=0A= + =A0 =A0 =A0 =A0Indicates that a peer has left the group.=0A= +=0A= +Properties=0A= +=0A= + =A0 =A0string Name [readonly]=0A= + =A0 =A0 =A0 =A0The SSID or name of the group.=0A= +=0A= + =A0 =A0boolean Owner [readonly]=0A= + =A0 =A0 =A0 =A0True if this device is the group owner.=0A= +=0A= + =A0 =A0string Passphrase [readonly]=0A= + =A0 =A0 =A0 =A0The passphrase for the group (if owner).=0A= +=0A= + =A0 =A0object OwnerPath [readonly]=0A= + =A0 =A0 =A0 =A0Object path of the group owner (if not owner).=0A= +=0A= + =A0 =A0boolean Persistent [readonly]=0A= + =A0 =A0 =A0 =A0True if the group is persistent.=0A= +=0A= + =A0 =A0boolean Tethering [readwrite]=0A= + =A0 =A0 =A0 =A0True if tethering is enabled for the group.=0A= +=0A= + =A0 =A0uint32 Freq [readonly]=0A= + =A0 =A0 =A0 =A0Frequency of the group.=0A= =0A=