X-Git-Url: http://www.project-moonshot.org/gitweb/?a=blobdiff_plain;f=doc%2Fdbus.doxygen;h=b0e67d45b0376d875824d61bfddbc6c483eb58fc;hb=b44d9c760fda85797187f1d0e97be47ed0182ed6;hp=032d595ad6951f2d613bd421c3ad7afc0257c75b;hpb=dc1a341dec54c28c3351ee7edab9ccaf7b68861f;p=mech_eap.git diff --git a/doc/dbus.doxygen b/doc/dbus.doxygen index 032d595..b0e67d4 100644 --- a/doc/dbus.doxygen +++ b/doc/dbus.doxygen @@ -97,6 +97,11 @@ registered in the bus with fi.w1.wpa_supplicant1 name.
Getting an interface object path failed for an unknown reason.
+ +
  • +

    ExpectDisconnect ( ) --> nothing

    +

    Notify wpa_supplicant of an externally triggered disconnection, e.g., due to system suspend.

    +
    • \subsection dbus_main_properties Properties @@ -307,6 +312,16 @@ fi.w1.wpa_supplicant1.CreateInterface.
  • +

    Reconnect ( ) --> nothing

    +

    Attempt reconnection and connect if in disconnected state.

    +

    Possible errors

    +
    +
    fi.w1.wpa_supplicant1.InterfaceDisabled
    +
    The interface is disabled.
    +
    +
    • + +

  • AddBlob ( s : name, ay : data ) --> nothing

    Adds a blob to the interface.

    Arguments

    @@ -441,6 +456,62 @@ fi.w1.wpa_supplicant1.CreateInterface.
  • +

    VendorElemAdd ( i: frame_id, ay: ielems ) --> nothing

    +

    Add Vendor Elements to corresponding frame ID.

    +

    Arguments

    +
    +
    i : frame_id
    +
    Frame ID for which Vendor specific IE is to be added.
    +
    ay : ielems
    +
    Information Element(s).
    +
    +

    Possible errors

    +
    +
    fi.w1.wpa_supplicant1.InvalidArgs
    +
    The "ielems" argument is not a properly formatted or size mismatch.
    +
    fi.w1.wpa_supplicant1.NoMemory
    +
    Needed memory was not possible to get allocated.
    +
    +
    • +
  • +

    VendorElemGet ( i: frame_id ) --> ay: ielems

    +

    Get Vendor Elements of corresponding frame ID.

    +

    Arguments

    +
    +
    i : frame_id
    +
    Frame ID for which Vendor specific IE is being queried.
    +
    ay : ielems
    +
    Information Element(s).
    +
    +

    Possible errors

    +
    +
    fi.w1.wpa_supplicant1.InvalidArgs
    +
    The "frame_id" argument is not valid.
    +
    +
    • +
  • +

    VendorElemRem ( i: frame_id, ay: ielems ) --> nothing

    +

    Remove Vendor Elements of corresponding frame ID.

    +

    Arguments

    +
    +
    i : frame_id
    +
    Frame ID for which Vendor specific IE is to be removed.
    +
    ay : ielems
    +
    Information Element(s) OR * to remove all.
    +
    +

    Possible errors

    +
    +
    fi.w1.wpa_supplicant1.InvalidArgs
    +
    The "ielems" argument is not a properly formatted or size mismatch.
    +
    fi.w1.wpa_supplicant1.NoMemory
    +
    Needed memory was not possible to get allocated.
    +
    +
    • +
  • +

    SaveConfig ( ) --> nothing

    +

    Save configuration to the configuration file.

    +
    • +

  • EAPLogoff ( ) --> nothing

    IEEE 802.1X EAPOL state machine logoff.

    • @@ -610,6 +681,11 @@ fi.w1.wpa_supplicant1.CreateInterface.
  • +

    ConfigFile - s - (read)

    +

    Configuration file path. Returns an empty string if no configuration file is in use.

    +
    • + +

  • CurrentBSS - o - (read)

    Path to D-Bus object representing BSS which wpa_supplicant is associated with, or "/" if is not associated at all.

    • @@ -663,6 +739,256 @@ fi.w1.wpa_supplicant1.CreateInterface.

    DisconnectReason - i - (read)

    The most recent IEEE 802.11 reason code for disconnect. Negative value indicates locally generated disconnection.

    + +
  • +

    AssocStatusCode - i - (read)

    +

    The most recent IEEE 802.11 status code for association rejection.

    +
    • + +
  • +

    EapolVersion - s - (read/write)

    +

    IEEE 802.1X/EAPOL version number

    +
    • + +
  • +

    Bgscan - s - (read/write)

    +

    Background scan and roaming parameters or an empty string if none

    +
    • + +
  • +

    DisableScanOffload - s - (read/write)

    +

    Disable automatic offloading of scan requests

    +
    • + +
  • +

    OpenscEnginePath - s - (read/write)

    +

    Path to the OpenSSL engine for opensc

    +
    • + +
  • +

    OpensslCiphers - s - (read/write)

    +

    OpenSSL cipher string

    +
    • + +
  • +

    PcscReader - s - (read/write)

    +

    PC/SC reader name prefix

    +
    • + +
  • +

    PcscPin - s - (read/write)

    +

    PIN for USIM, GSM SIM, and smartcards

    +
    • + +
  • +

    ExternalSim - s - (read/write)

    +

    Use external processing for SIM/USIM operations

    +
    • + +
  • +

    DriverParam - s - (read/write)

    +

    Driver interface parameters

    +
    • + +
  • +

    Dot11RSNAConfigPMKLifetime - s - (read/write)

    +

    Maximum lifetime of a PMK

    +
    • + +
  • +

    Dot11RSNAConfigPMKReauthThreshold - s - (read/write)

    +

    PMK re-authentication threshold

    +
    • + +
  • +

    Dot11RSNAConfigSATimeout - s - (read/write)

    +

    Security association timeout

    +
    • + +
  • +

    BssMaxCount - s - (read/write)

    +

    Maximum number of BSS entries to keep in memory

    +
    • + +
  • +

    FilterSsids - s - (read/write)

    +

    SSID-based scan result filtering

    +
    • + +
  • +

    FilterRssi - s - (read/write)

    +

    RSSI-based scan result filtering

    +
    • + +
  • +

    MaxNumSta - s - (read/write)

    +

    Maximum number of STAs in an AP/P2P GO

    +
    • + +
  • +

    DisassocLowAck - s - (read/write)

    +

    Disassocicate stations with massive packet loss

    +
    • + +
  • +

    Interworking - s - (read/write)

    +

    Whether Interworking (IEEE 802.11u) is enabled

    +
    • + +
  • +

    Hessid - s - (read/write)

    +

    Homogenous ESS identifier

    +
    • + +
  • +

    AccessNetworkType - s - (read/write)

    +

    Access Network Type

    +
    • + +
  • +

    PbcInM1 - s - (read/write)

    +

    AP mode WPS probing workaround for PBC with Windows 7

    +
    • + +
  • +

    Autoscan - s - (read/write)

    +

    Automatic scan parameters or an empty string if none

    +
    • + +
  • +

    WpsNfcDevPwId - s - (read/write)

    +

    NFC Device Password ID for password token

    +
    • + +
  • +

    WpsNfcDhPubkey - s - (read/write)

    +

    NFC DH Public Key for password token

    +
    • + +
  • +

    WpsNfcDhPrivkey - s - (read/write)

    +

    NFC DH Private Key for password token

    +
    • + +
  • +

    WpsNfcDevPw - s - (read/write)

    +

    NFC Device Password for password token

    +
    • + +
  • +

    ExtPasswordBackend - s - (read/write)

    +

    External password backend or an empty string if none

    +
    • + +
  • +

    P2pGoMaxInactivity - s - (read/write)

    +

    Timeout in seconds to detect STA inactivity

    +
    • + +
  • +

    AutoInterworking - s - (read/write)

    +

    Whether to use network selection automatically

    +
    • + +
  • +

    Okc - s - (read/write)

    +

    Whether to enable opportunistic key caching by default

    +
    • + +
  • +

    Pmf - s - (read/write)

    +

    Whether to enable/require PMF by default

    +
    • + +
  • +

    SaeGroups - s - (read/write)

    +

    Preference list of enabled groups for SAE

    +
    • + +
  • +

    DtimPeriod - s - (read/write)

    +

    Default DTIM period in Beacon intervals

    +
    • + +
  • +

    BeaconInt - s - (read/write)

    +

    Default Beacon interval in TU

    +
    • + +
  • +

    IgnoreOldScanRes - s - (read/write)

    +

    Ignore scan results older than request

    +
    • + +
  • +

    FreqList - s - (read/write)

    +

    Array of allowed scan frequencies or an empty string for all

    +
    • + +
  • +

    ScanCurFreq - s - (read/write)

    +

    Whether to scan only the current channel

    +
    • + +
  • +

    SchedScanInterval - s - (read/write)

    +

    schedule scan interval

    +
    • + +
  • +

    TdlsExternalControl - s - (read/write)

    +

    External control for TDLS setup requests

    +
    • + +
  • +

    OsuDir - s - (read/write)

    +

    OSU provider information directory

    +
    • + +
  • +

    WowlanTriggers - s - (read/write)

    +

    Wake-on-WLAN triggers

    +
    • + +
  • +

    P2pSearchDelay - s - (read/write)

    +

    Extra delay between concurrent search iterations

    +
    • + +
  • +

    MacAddr - s - (read/write)

    +

    MAC address policy default

    +
    • + +
  • +

    RandAddrLifetime - s - (read/write)

    +

    Lifetime of random MAC address in seconds

    +
    • + +
  • +

    PreassocMacAddr - s - (read/write)

    +

    Pre-association MAC address policy

    +
    • + +
  • +

    KeyMgmtOffload - s - (read/write)

    +

    Use key management offload

    +
    • + +
  • +

    PassiveScan - s - (read/write)

    +

    Whether to force passive scan for network connection

    +
    • + +
  • +

    ReassocSameBssOptim - s - (read/write)

    +

    Whether to optimize reassoc-to-same-BSS

    +
    • + +
  • +

    WpsPriority - s - (read/write)

    +

    Priority for the networks added through WPS

    +
    • \subsection dbus_interface_signals Signals @@ -905,10 +1231,11 @@ Interface for performing WPS (Wi-Fi Simple Config) operations.

    Arguments

    s : event
    -
    Event type. Possible values are: "success, "fail" and "m2d"
    +
    Event type. Possible values are: "success, "fail", "m2d", and + "pbc-overlap".
    a{sv} : args
    - Event arguments. Empty for success event, one entry ( "msg" : i ) for fail event and following entries for m2d event: + Event arguments. Empty for success and pbc-overlap events, error information ( "msg" : i, "config_error" : i, "error_indication" : i ) for fail event and following entries for m2d event: @@ -968,7 +1295,7 @@ Interface for performing P2P (Wi-Fi Peer-to-Peer) P2P Device operations.
    config_methodsValue type
    manufacturerq
    - +
    KeyValue typeDescriptionRequired
    TimeoutiTimeout for operating in secondsno
    RequestedDevicesTypesaayWPS Device Types to search forno
    RequestedDeviceTypesaayWPS Device Types to search forno
    DiscoveryTypes"start_with_full" (default, if not specified), "social", "progressive"no
    @@ -1108,6 +1435,23 @@ Interface for performing P2P (Wi-Fi Peer-to-Peer) P2P Device operations.
  • +

    RemoveClient ( a{sv} : args ) --> nothing

    +

    Remove the client from all groups (operating and persistent) from the local GO.

    +

    Arguments

    +
    +
    a{sv} : args
    +
    + A dictionary with parameters for removing a client: + + + + +
    KeyValue typeDescriptionRequired
    peeroObject path for peer's P2P Device Addressyes
    ifacesInterface address[MAC Address format] of the peer to be disconnected. Required if object path is not provided.no
    +
    +
    +
    • + +

  • Flush ( nothing ) --> nothing

    Flush P2P peer table and state.

    • @@ -1249,6 +1593,7 @@ Interface for performing P2P (Wi-Fi Peer-to-Peer) P2P Device operations. GOIntentu PersistentReconnectb ListenRegClassu + ListenChannelu OperRegClassu OperChannelu SsidPostfixs @@ -1292,6 +1637,20 @@ Interface for performing P2P (Wi-Fi Peer-to-Peer) P2P Device operations.
  • +

    DeviceFoundProperties ( o : path, a{sv} : properties )

    +

    A new peer device has been found.

    +

    Arguments

    +
    +
    o : path
    +
    A D-Bus path to an object representing the found peer device.
    +
    +
    +
    a{sv} : properties
    +
    A dictionary containing properties of the found peer device.
    +
    +
    • + +

  • DeviceLost ( o : path )

    • @@ -1386,7 +1745,7 @@ Interface for performing P2P (Wi-Fi Peer-to-Peer) P2P Device operations.
  • -

    GONegotiationRequest ( o : path, i : dev_passwd_id )

    +

    GONegotiationRequest ( o : path, q : dev_passwd_id, y : device_go_intent )

  • @@ -1504,6 +1863,35 @@ Interface for performing P2P (Wi-Fi Peer-to-Peer) P2P Device operations.
    • + +
  • +

    InvitationReceived ( a{sv} : properties )

    +

    +

    Arguments

    +
    +
    a{sv} : properties
    +
    A dictionary with following information: + + + + + + + +
    KeyValue typeDescription
    saayOptionally present
    go_dev_addrayOptionally present
    bssidayOptionally present
    persistent_idiOptionally present
    op_freqi
    +
    +
    +
    • + +
  • +

    GroupFormationFailure ( s : reason )

    +

    +

    Arguments

    +
    +
    s : reason
    +
    Reason for failure or empty string if not known.
    +
    +
    • \section dbus_bss fi.w1.wpa_supplicant1.BSS @@ -1642,6 +2030,18 @@ Interface implemented by objects representing P2P peer devices.
  • +

    ModelName - s - (read)

    +
    • + +
  • +

    ModelNumber - s - (read)

    +
    • + +
  • +

    SerialNumber - s - (read)

    +
    • + +

  • PrimaryDeviceType - ay - (read)