3
0
mirror of https://git.kernel.org/pub/scm/network/wireless/iwd.git synced 2024-11-27 19:59:28 +01:00
iwd/doc/p2p-peer-api.txt
2021-10-06 15:59:39 -05:00

143 lines
3.1 KiB
Plaintext

P2PPeer hierarchy
=================
Service net.connman.iwd
Interface net.connman.iwd.p2p.Peer [Experimental]
Object path /net/connman/iwd/{phy0,phy1,...}/p2p_peers/{aa_bb_cc_dd_ee_ff}
Methods Disconnect()
If connected, disconnect from this peer.
Connections are established by calling methods on
the net.connman.iwd.SimpleConfiguration interface
on the same object -- see wsc-api.txt.
Possible errors: [service].Error.Failed
[service].Error.NotConnected
Properties string Name [readonly]
P2P Peer's display name
string Address [readonly]
The peer's unique Device Address in the xx:xx:xx:xx:xx:xx
format.
string DeviceCategory [readonly]
The category part of the peer's declared
Primary Device Type. Takes one of the following
values, "unknown-device" being reported when the
device type is not one of those defined in the
Wi-Fi Simple Configuration specification:
'computer',
'input-device',
'printer-scanner',
'camera',
'storage',
'network-infrastructure',
'display',
'multimedia-device',
'gaming-device',
'telephone',
'audio-device',
'docking-device',
'unknown-device'.
string DeviceSubcategory [readonly, optional]
The Sub Category part of the peer's declared
Primary Device Type, if recognised by WSC.
Supported values are:
'pc',
'server',
'media-center',
'ultra-mobile-pc',
'notebook',
'desktop',
'mobile-internet-device',
'netbook',
'tablet',
'ultrabook',
'keyboard',
'mouse',
'joystick',
'trackball',
'gaming-controller',
'remote',
'touchscreen',
'biometric-reader',
'barcode-reader',
'printer-print-server',
'scanner',
'fax',
'copier',
'printer-scanner-fax-copier',
'digital-still-camera',
'video-camera',
'web-camera',
'security-camera',
'nas',
'ap',
'router',
'switch',
'gateway',
'bridge',
'television',
'electronic-picture-frame',
'projector',
'monitor',
'dar',
'pvr',
'mcx',
'set-top-box',
'media-server-adapter-extender',
'portable-video-player',
'xbox',
'xbox360',
'playstation',
'game-console-adapter',
'portable-gaming-device',
'windows-mobile',
'single-mode-phone',
'dual-mode-phone',
'single-mode-smartphone',
'dual-mode-smartphone',
'audio-tuner-receiver',
'speakers',
'portable-music-player',
'headset',
'headphones',
'microphone',
'home-theater-system',
'computer-docking-station',
'media-kiosk'.
object Device [readonly]
The object with a net.connman.iwd.p2p.Device
interface that discovered this peer -- see
p2p-api.txt.
boolean Connected [readonly]
Whether there's currently an active connection
to this peer. This property is read-only and
changes as a result of method calls on the
net.connman.iwd.SimpleConfiguration interface
on the same object -- see wsc-api.txt -- and
calls to Disconnect on this interface.
string ConnectedInterface [readonly, optional]
If connected, this property contains the name
of the network interface used for the
connection.
string ConnectedIP [readonly, optional]
The peer's IPv4 address if connected.