Blame doc/network-api.txt

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