summaryrefslogtreecommitdiffstats
path: root/network/network-api.txt
diff options
context:
space:
mode:
authorLuiz Augusto von Dentz <luiz.dentz@openbossa.org>2007-04-16 14:03:38 +0000
committerLuiz Augusto von Dentz <luiz.dentz@openbossa.org>2007-04-16 14:03:38 +0000
commitea69da4ac5a927fde86de78ceaac6deadfedbff6 (patch)
tree977420a0a138e84e616f9ba57cd3684eea405540 /network/network-api.txt
parent04f62adc118d1049e0aa2de19653004d4ccdf4b8 (diff)
Update network service documentation.
Diffstat (limited to 'network/network-api.txt')
-rw-r--r--network/network-api.txt85
1 files changed, 73 insertions, 12 deletions
diff --git a/network/network-api.txt b/network/network-api.txt
index c38b3e63..4edebffd 100644
--- a/network/network-api.txt
+++ b/network/network-api.txt
@@ -14,12 +14,16 @@ Methods string CreateServer(string uuid)
Creates a network server object(GN or NAP).
- Possible errors: TBD
+ Possible errors:org.bluez.network.AlreadyExists
+ org.bluez.network.NotSupported
+ org.bluez.network.ConnectionAttemptFailed
+ org.bluez.network.Failed
void RemoveServer(string path)
Removes the network server object for given path.
- Possible errors: TBD
+ Possible errors:org.bluez.network.DoesNotExist
+ org.bluez.network.Failed
array{string} ListServers()
@@ -30,16 +34,29 @@ Methods string CreateServer(string uuid)
Creates a network connection object(NAP or GN).
+ Possible errors:org.bluez.network.AlreadyExists
+ org.bluez.network.NotSupported
+ org.bluez.network.ConnectionAttemptFailed
+ org.bluez.network.Failed
+
string RemoveConnection(string path)
Removes a network connection object for a given path.
- Possible errors: TBD
+ Possible errors:org.bluez.network.DoesNotExist
+ org.bluez.network.Failed
array{string} ListConnections()
Returns an array of available network connections paths.
+ string FindConnection(string pattern)
+
+ Returns an array of available network connections paths.
+
+ Possible errors:org.bluez.network.DoesNotExist
+ org.bluez.network.Failed
+
Signals
void ServerCreated(string path)
@@ -57,31 +74,52 @@ Interface org.bluez.network.Server
Object path /org/bluez/network/server*
Methods string GetUUID()
+
Returns the uuid 128 string representation of the server.
- void Enable() // do this automatically?
- void Disable() // do this automatically?
+ void Enable()
+
+ Enable server and updates service record.
+
+ Possible errors:org.bluez.network.AlreadyExists
+ org.bluez.network.Failed
+
+ void Disable()
+
+ Disable server and remove service record.
+
+ Possible errors:org.bluez.network.Failed
+
void SetName(string name)
Sets the name attribute.
string GetName()
+
Returns the service name.
void SetAddressRange(string start, string end)
+
TBD
void SetRouting(string interface)
+
TBD
void SetSecurity(bool enable)
- TBD
+
+ Enable or disable encryption.
bool GetSecurity()
- TBD
+
+ Returns server encryption.
Signals
+ void Enabled()
+
+ void Disabled()
+
Network Connection hierarchy (experimental)
===========================================
@@ -89,28 +127,51 @@ Interface org.bluez.network.Connection
Object path /org/bluez/network/connection*
Methods string GetAddress()
+
Returns the Bluetooth address of the ending point.
string GetUUID()
+
Returns the uuid 128 string representation of
the connected service.
string GetName()
- TBD
+
+ Returns the string representation of connected host.
+
+ Possible errors:org.bluez.network.Failed
string GetDescription()
- TBD
+
+ Returns the string description of connected host.
+
+ Possible errors:org.bluez.network.Failed
string GetInterface()
- TBD
+
+ Returns the string network interface.
+
+ Possible errors:org.bluez.network.Failed
void Connect()
- TBD
+
+ Connects to host.
+
+ Possible errors:org.bluez.network.ConnectionAttemptFailed
+ org.bluez.network.Failed
void Disconnect()
- TBD
+
+ Disconnects to host.
+
+ Possible errors:org.bluez.network.Failed
bool IsConnected()
+
Returns the connection status.
Signals
+
+ void Connected()
+
+ void Disconnected()