Blame doc/network-api.txt

Packit 34410b
BlueZ D-Bus Network API description
Packit 34410b
***********************************
Packit 34410b
Packit 34410b
Packit 34410b
Network hierarchy
Packit 34410b
=================
Packit 34410b
Packit 34410b
Service		org.bluez
Packit 34410b
Interface	org.bluez.Network1
Packit 34410b
Object path	[variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX
Packit 34410b
Packit 34410b
Methods		string Connect(string uuid)
Packit 34410b
Packit 34410b
			Connect to the network device and return the network
Packit 34410b
			interface name. Examples of the interface name are
Packit 34410b
			bnep0, bnep1 etc.
Packit 34410b
Packit 34410b
			uuid can be either one of "gn", "panu" or "nap" (case
Packit 34410b
			insensitive) or a traditional string representation of
Packit 34410b
			UUID or a hexadecimal number.
Packit 34410b
Packit 34410b
			The connection will be closed and network device
Packit 34410b
			released either upon calling Disconnect() or when
Packit 34410b
			the client disappears from the message bus.
Packit 34410b
Packit 34410b
			Possible errors: org.bluez.Error.AlreadyConnected
Packit 34410b
					 org.bluez.Error.ConnectionAttemptFailed
Packit 34410b
Packit 34410b
		void Disconnect()
Packit 34410b
Packit 34410b
			Disconnect from the network device.
Packit 34410b
Packit 34410b
			To abort a connection attempt in case of errors or
Packit 34410b
			timeouts in the client it is fine to call this method.
Packit 34410b
Packit 34410b
			Possible errors: org.bluez.Error.Failed
Packit 34410b
Packit 34410b
Properties	boolean Connected [readonly]
Packit 34410b
Packit 34410b
			Indicates if the device is connected.
Packit 34410b
Packit 34410b
		string Interface [readonly]
Packit 34410b
Packit 34410b
			Indicates the network interface name when available.
Packit 34410b
Packit 34410b
		string UUID [readonly]
Packit 34410b
Packit 34410b
			Indicates the connection role when available.
Packit 34410b
Packit 34410b
Packit 34410b
Network server hierarchy
Packit 34410b
========================
Packit 34410b
Packit 34410b
Service		org.bluez
Packit 34410b
Interface	org.bluez.NetworkServer1
Packit 34410b
Object path	/org/bluez/{hci0,hci1,...}
Packit 34410b
Packit 34410b
Methods		void Register(string uuid, string bridge)
Packit 34410b
Packit 34410b
			Register server for the provided UUID. Every new
Packit 34410b
			connection to this server will be added the bridge
Packit 34410b
			interface.
Packit 34410b
Packit 34410b
			Valid UUIDs are "gn", "panu" or "nap".
Packit 34410b
Packit 34410b
			Initially no network server SDP is provided. Only
Packit 34410b
			after this method a SDP record will be available
Packit 34410b
			and the BNEP server will be ready for incoming
Packit 34410b
			connections.
Packit 34410b
Packit 34410b
		void Unregister(string uuid)
Packit 34410b
Packit 34410b
			Unregister the server for provided UUID.
Packit 34410b
Packit 34410b
			All servers will be automatically unregistered when
Packit 34410b
			the calling application terminates.