[RFC obexd v2 08/21] client-doc: replace parameter dict with conventional ones

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Common arguments are required as formal parameters in the D-Bus API, and
an additional dictionary is used to pass target-specific parameters.
This will allow future extensions without breaking the method signature.
---
 doc/client-api.txt |   23 ++++++++++++-----------
 1 files changed, 12 insertions(+), 11 deletions(-)

diff --git a/doc/client-api.txt b/doc/client-api.txt
index 65de1f1..ad92869 100644
--- a/doc/client-api.txt
+++ b/doc/client-api.txt
@@ -11,23 +11,24 @@ Service		org.openobex.client
 Interface	org.openobex.Client
 Object path	/
 
-Methods		object CreateSession(dict device)
+Methods		object CreateSession(string source, string destination,
+					string target, dict args)
 
-			Create a new OBEX session. The device is configured
-			via properties like in SendFiles.
+			Create a new OBEX session for the given source (local)
+			address, destination (remote) address and target. The
+			supported target values are:
+				- "OPP"
+				- "FTP"
+				- "SYNC"
+				- "PBAP"
+
+			The fourth argument is used to pass target-specific
+			parameters.
 
 		void RemoveSession(object session)
 
 			Unregister session and abort pending transfers.
 
-Properties	string Target
-
-		string Source
-
-		string Destination
-
-		byte Channel
-
 Session hierarchy
 =================
 
-- 
1.7.6.4

--
To unsubscribe from this list: send the line "unsubscribe linux-bluetooth" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html


[Index of Archives]     [Bluez Devel]     [Linux Wireless Networking]     [Linux Wireless Personal Area Networking]     [Linux ATH6KL]     [Linux USB Devel]     [Linux Media Drivers]     [Linux Audio Users]     [Linux Kernel]     [Linux SCSI]     [Big List of Linux Books]

  Powered by Linux