From patchwork Mon Nov 18 22:31:25 2013 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Paul Stewart X-Patchwork-Id: 292222 Return-Path: X-Original-To: patchwork-incoming@ozlabs.org Delivered-To: patchwork-incoming@ozlabs.org Received: from maxx.maxx.shmoo.com (maxx.shmoo.com [205.134.188.171]) (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) (Client CN "maxx.shmoo.com", Issuer "CA Cert Signing Authority" (not verified)) by ozlabs.org (Postfix) with ESMTPS id 245CB2C0099 for ; Tue, 19 Nov 2013 09:34:50 +1100 (EST) Received: from localhost (localhost [127.0.0.1]) by maxx.maxx.shmoo.com (Postfix) with ESMTP id 418439C0BF; Mon, 18 Nov 2013 17:34:48 -0500 (EST) X-Virus-Scanned: amavisd-new at maxx.shmoo.com Received: from maxx.maxx.shmoo.com ([127.0.0.1]) by localhost (maxx.shmoo.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id PA3CMQOYmVOp; Mon, 18 Nov 2013 17:34:48 -0500 (EST) Received: from maxx.shmoo.com (localhost [127.0.0.1]) by maxx.maxx.shmoo.com (Postfix) with ESMTP id 946069C0C6; Mon, 18 Nov 2013 17:34:43 -0500 (EST) X-Original-To: mailman-post+hostap@maxx.shmoo.com Delivered-To: mailman-post+hostap@maxx.shmoo.com Received: from localhost (localhost [127.0.0.1]) by maxx.maxx.shmoo.com (Postfix) with ESMTP id B86439C0C6 for ; Mon, 18 Nov 2013 17:34:41 -0500 (EST) X-Virus-Scanned: amavisd-new at maxx.shmoo.com Received: from maxx.maxx.shmoo.com ([127.0.0.1]) by localhost (maxx.shmoo.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id w9edZr1NWMY3 for ; Mon, 18 Nov 2013 17:34:36 -0500 (EST) Received: from mail-ve0-f202.google.com (mail-ve0-f202.google.com [209.85.128.202]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) (Client CN "smtp.gmail.com", Issuer "Google Internet Authority G2" (not verified)) by maxx.maxx.shmoo.com (Postfix) with ESMTPS id A1ED49C0BF for ; Mon, 18 Nov 2013 17:34:36 -0500 (EST) Received: by mail-ve0-f202.google.com with SMTP id c14so654751vea.3 for ; Mon, 18 Nov 2013 14:34:36 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:date:subject:to:message-id; bh=n+6zfxxKQYBSs1nmqcBc6pA/0DIQ+JWxIoIgdAT6ZqY=; b=lQTyS72yuNx9Mezqr0YeCizSwdHzWXIu4krf/uE5X6k/HGfeik8ojqlD2sFHtH/01O MDNi/vyxR1earslI3NCjPIBZFG+DsWxgTm/ELJJ9LijAugK5MSd2oiKbfHkf+2/t9lP3 AGVUl87RDAIAuH9o583RRkBu+UFqr/OYXAQyoqyh/MioVmDZseGX37g1bhEdGCQycnku l3W4hIAdeQPRr32oBsnJVBCvFkpuJ3nVVS0TuA+wQXnKRjCXDKyHbzhVSd1K2ema9NrJ qOfKp2JsLCvxjBBH2bOSWzQ8eB6p9cmbj9Z4itkooUhsYgibFiAsAejYU4k6hZO53Cgg aC+Q== X-Gm-Message-State: ALoCoQkM6kih25u2R0zER0JwlNLN/i5uG0QgdOX6cgWWYfaOJ8LI36pFFFMtSsgl/e3e1cQTRnXvc7doDYP/gK61nCM9qU3QsjAKauHyBrHF9A1Vn3pNwtR4wWyJoEIhJH9v3HWDz56ERUHTTKz88TfOEzOUK+NIrei0t0DCLcEydcogHtxIwWNYgdhg8UyIutzAXAi5GPbJ0EP4zSTSODS6enxBCH+ThUtri7DKN+lINnhodMp6kUM= X-Received: by 10.58.23.166 with SMTP id n6mr9098765vef.13.1384814076129; Mon, 18 Nov 2013 14:34:36 -0800 (PST) Received: from corp2gmr1-2.hot.corp.google.com (corp2gmr1-2.hot.corp.google.com [172.24.189.93]) by gmr-mx.google.com with ESMTPS id vn2si891781igb.2.2013.11.18.14.34.35 for (version=TLSv1.1 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Mon, 18 Nov 2013 14:34:36 -0800 (PST) Received: from clearcreek.mtv.corp.google.com (clearcreek.mtv.corp.google.com [172.22.73.104]) by corp2gmr1-2.hot.corp.google.com (Postfix) with ESMTP id 93A2A5A41A0 for ; Mon, 18 Nov 2013 14:34:35 -0800 (PST) Received: by clearcreek.mtv.corp.google.com (Postfix, from userid 110058) id 1FBA720097F; Mon, 18 Nov 2013 14:34:34 -0800 (PST) From: Paul Stewart Date: Mon, 18 Nov 2013 14:31:25 -0800 Subject: [PATCH] dbus_new: Add documentation for D-Bus TDLS methods To: hostap@lists.shmoo.com Message-Id: <20131118223435.1FBA720097F@clearcreek.mtv.corp.google.com> X-BeenThere: hostap@lists.shmoo.com X-Mailman-Version: 2.1.11 Precedence: list List-Id: HostAP Project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Sender: hostap-bounces@lists.shmoo.com Errors-To: hostap-bounces@lists.shmoo.com Signed-hostap: Paul Stewart --- doc/dbus.doxygen | 67 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) diff --git a/doc/dbus.doxygen b/doc/dbus.doxygen index 7e4c7c9..87093ed 100644 --- a/doc/dbus.doxygen +++ b/doc/dbus.doxygen @@ -334,6 +334,73 @@ fi.w1.wpa_supplicant1.CreateInterface.
  • +

    TDLSDiscover ( s : peer_address ) --> nothing

    +

    Initiate a TDLS discovery for a peer.

    +

    Arguments

    +
    +
    s : peer_address
    +
    MAC address for the peer to perform TDLS discovery.
    +
    +

    Possible errors

    +
    +
    fi.w1.wpa_supplicant1.InvalidArgs
    +
    The "peer_address" argument is not a properly formatted MAC.
    +
    fi.w1.wpa_supplicant1.UnknownError
    +
    Initiating the TDLS operation failed for an unknown reason.
    +
    +
  • +
  • +

    TDLSSetup ( s : peer_address ) --> nothing

    +

    Setup a TDLS session for a peer.

    +

    Arguments

    +
    +
    s : peer_address
    +
    MAC address for the peer to perform TDLS setup.
    +
    +

    Possible errors

    +
    +
    fi.w1.wpa_supplicant1.InvalidArgs
    +
    The "peer_address" argument is not a properly formatted MAC.
    +
    fi.w1.wpa_supplicant1.UnknownError
    +
    Initiating the TDLS operation failed for an unknown reason.
    +
    +
  • +
  • +

    TDLSStatus ( s : peer_address ) --> s

    +

    Return TDLS status with respect to a peer.

    +

    Arguments

    +
    +
    s : peer_address
    +
    MAC address for the peer for which status is requested.
    +
    +

    Returns

    +
    +
    s : status
    +
    Current status of the TDLS link with the selected peer.
    +
    +

    Possible errors

    +
    +
    fi.w1.wpa_supplicant1.InvalidArgs
    +
    The "peer_address" argument is not a properly formatted MAC.
    +
    +
  • +
  • +

    TDLSTeardown ( s : peer_address ) --> nothing

    +

    Tear down a TDLS session with a peer.

    +

    Arguments

    +
    +
    s : peer_address
    +
    MAC address for the peer to tear down TDLS connectivity with.
    +
    +

    Possible errors

    +
    +
    fi.w1.wpa_supplicant1.InvalidArgs
    +
    The "peer_address" argument is not a properly formatted MAC.
    +
    fi.w1.wpa_supplicant1.UnknownError
    +
    Initiating the TDLS operation failed for an unknown reason.
    +
    +
  • +
  • EAPLogoff ( ) --> nothing

    IEEE 802.1X EAPOL state machine logoff.