diff options
| author | Samuel Ortiz <sameo@linux.intel.com> | 2012-05-25 16:06:23 +0200 |
|---|---|---|
| committer | Samuel Ortiz <sameo@linux.intel.com> | 2012-05-26 16:22:47 +0200 |
| commit | 4e92706073a4eff5e39de81bd6ec7c298ef70aff (patch) | |
| tree | 5c0cf3f342e6ec97ece3accee3ddff5b7192ef34 /doc | |
| parent | 8c31393aed8ad8b9548e6e9d95cbaf30881d4b9b (diff) | |
| download | neard-4e92706073a4eff5e39de81bd6ec7c298ef70aff.tar.gz neard-4e92706073a4eff5e39de81bd6ec7c298ef70aff.tar.bz2 neard-4e92706073a4eff5e39de81bd6ec7c298ef70aff.zip | |
adapter: Implement new polling loop D-Bus API
The simple StartPoll is replaced with a polling loop method, where polling
mode is specified. It can be Initiator, Target or both.
When starting the polling loop in Target mode an NFC device could
eventually activate us.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/adapter-api.txt | 21 |
1 files changed, 11 insertions, 10 deletions
diff --git a/doc/adapter-api.txt b/doc/adapter-api.txt index ecfde6c..239a89e 100644 --- a/doc/adapter-api.txt +++ b/doc/adapter-api.txt @@ -21,11 +21,15 @@ Methods: dict GetProperties() Possible Errors: org.neard.Error.DoesNotExist org.neard.Error.InvalidArguments - void StartPoll() + void StartPollLoop(string mode) - The adapter will start polling for targets when calling - this method. It is only valid when the adapter is in - initiator mode. + Starts the adapter polling loop. Depending on the mode, + the adapter will start polling for targets, listening + for NFC devices or both. + The mode parameter can have the following values: + "Initiator", "Target". For any other value, the adapter + will start the polling loop in both target and initiator + mode. This process will start emitting TagFound and PropertyChanged "Polling" signals. @@ -34,11 +38,9 @@ Methods: dict GetProperties() org.neard.Error.Failed org.neard.Error.NotSupported - void StopPoll() + void StopPollLoop() - The adapter will stop polling for targets when calling - this method. It is only available when the adapter is in - initiator mode. + The adapter polling loop will stop. Possible errors: org.neard.Error.NotReady org.neard.Error.Failed @@ -93,12 +95,11 @@ Signals PropertyChanged(string name, variant value) in sight, or when it's been de-activated. -Properties: string Mode [readwrite] +Properties: string Mode [readonly] The adapter mode. Valid types are "initiator" and "target". - The default value for the adapter mode is "initiator". boolean Powered [readwrite] |