Linux bluetooth development
 help / color / mirror / Atom feed
From: Bartosz Szatkowski <bulislaw@linux.com>
To: linux-bluetooth@vger.kernel.org
Subject: [RFC] API for MAP client in obex-client
Date: Thu,  3 Nov 2011 15:00:31 +0100	[thread overview]
Message-ID: <1320328831-5490-1-git-send-email-bulislaw@linux.com> (raw)
In-Reply-To: <CAPGrrxXkvaNjnUT9vJ8sdnHuabF7zwtWnOnnbLD1+G0huvj1xw@mail.gmail.com>

Hi,
below proposed API for MAP client in obex-client, for now just some
generic functions and browsing support.

Messages Access hierarchy
=========================

Service		org.openobex.client
Interface	org.openobex.MessagesAccess
Object path	[variable prefix]/{session0,session1,...}

Methods		dict(uint8 tag, variant value) GetAppParams()

			Retrieve application parameters connected to the last MSE 
			response. Application parameters corresponding to given call
			are accessible until next request is sent.

			Parameters are converted to unsigned integers of corresponding sizes
			(MAP specification section 6.3.1) or NULL-terminated strings.
			In case of parameters not mentioned in MAP specification value 
			becomes struct of (uint8 length, array{uint8}).

			See MAP specification (section corresponding to given function)
			for more details on returned parameters.

		void SetFolder(boolean cdup, string name)

			Set working directory for current session.

			|  cdup  | folder name | operation    | 
			|=====================================|
			| FALSE  | empty       | cd /         |
			|--------+-------------+--------------|
			| FALSE  | name        | cd name      |
			|--------+-------------+--------------|
			| TRUE   | [name]      | cd ..[/name] |
			+-------------------------------------+

		array{dict(string property, string value)}
		GetFolderListing(dict(uint8 tag, uint16 value))

			Retrieve list of names (and all other properties returned by MSE)
			for directories in CWD.

			Parameters as in MAP specification section 5.4.

		array{dict(string property, string value)}
		GetMessageListing(string folder, array{uint8 tag, variant value})

			Return message listing for given subfolder of CWD or directly
			CWD if folder field is empty, format of each dict entry
			corresponds to the message listing format (MAP specification
			section 3.1.6).

			Parameters as in MAP specification section 5.5.

		unix_fd msgfd
		GetMessage(string handle, dict(uint8 tag, variant value))

			Retrieve message from remote device and return file descriptor,
			from which message data (in BMSG format) may be read.

			Parameters as in MAP specification section 5.6.

		void SetMessageStatus(string handle, uint8 indicator, uint8 value)

			Modify status of a message on remote device.

			Parameters as in MAP specification section 5.7.

		void UpdateInbox()

			Initiate update of inbox status on remote device.

-- 
Pozdrowienia - Cheers,
Bartosz Szatkowski

  parent reply	other threads:[~2011-11-03 14:00 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-11-03 13:44 [RFC] API for MAP client in obex-client Bartosz Szatkowski
2011-11-03 13:52 ` Hendrik Sattler
2011-11-03 14:00 ` Bartosz Szatkowski [this message]
2011-11-03 14:08 ` Hendrik Sattler
2011-11-03 14:16   ` Bartosz Szatkowski
2011-11-03 15:13     ` Luiz Augusto von Dentz
2011-11-03 15:41       ` Anders Widen
2011-11-03 17:38       ` Bartosz Szatkowski
2011-11-03 17:59         ` Luiz Augusto von Dentz
2011-11-03 19:01           ` Bartosz Szatkowski
2011-11-04 12:00             ` Luiz Augusto von Dentz
2011-11-07  9:46               ` Bartosz Szatkowski
2011-11-07 10:37                 ` Luiz Augusto von Dentz
2011-11-07 12:42                   ` Bartosz Szatkowski
2011-11-07 13:20                     ` Luiz Augusto von Dentz
2011-11-07 15:10                       ` Bartosz Szatkowski
2011-11-07 19:38                         ` Luiz Augusto von Dentz

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1320328831-5490-1-git-send-email-bulislaw@linux.com \
    --to=bulislaw@linux.com \
    --cc=linux-bluetooth@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox