text: /*
   * wpa_supplicant/hostapd control interface library
   * Copyright (c) 2004-2006, Jouni Malinen <j@w1.fi>
   *
   * This program is free software; you can redistribute it and/or modify
   * it under the terms of the GNU General Public License version 2 as
   * published by the Free Software Foundation.
   *
   * Alternatively, this software may be distributed under the terms of BSD
   * license.
   *
   * See README and COPYING for more details.
   */
  
  #ifndef WPA_CTRL_H
  #define WPA_CTRL_H
  
  #ifdef  __cplusplus
  extern "C" {
  #endif
  
  /* wpa_supplicant control interface - fixed message prefixes */
  
  /** Interactive request for identity/password/pin */
  #define WPA_CTRL_REQ "CTRL-REQ-"
  
  /** Response to identity/password/pin request */
  #define WPA_CTRL_RSP "CTRL-RSP-"
  
  /* Event messages with fixed prefix */
  /** Authentication completed successfully and data connection enabled */
  #define WPA_EVENT_CONNECTED "CTRL-EVENT-CONNECTED "
  /** Disconnected, data connection is not available */
  #define WPA_EVENT_DISCONNECTED "CTRL-EVENT-DISCONNECTED "
  /** wpa_supplicant is exiting */
  #define WPA_EVENT_TERMINATING "CTRL-EVENT-TERMINATING "
  /** Password change was completed successfully */
  #define WPA_EVENT_PASSWORD_CHANGED "CTRL-EVENT-PASSWORD-CHANGED "
  /** EAP-Request/Notification received */
  #define WPA_EVENT_EAP_NOTIFICATION "CTRL-EVENT-EAP-NOTIFICATION "
  /** EAP authentication started (EAP-Request/Identity received) */
  #define WPA_EVENT_EAP_STARTED "CTRL-EVENT-EAP-STARTED "
  /** EAP method selected */
  #define WPA_EVENT_EAP_METHOD "CTRL-EVENT-EAP-METHOD "
  /** EAP authentication completed successfully */
  #define WPA_EVENT_EAP_SUCCESS "CTRL-EVENT-EAP-SUCCESS "
  /** EAP authentication failed (EAP-Failure received) */
  #define WPA_EVENT_EAP_FAILURE "CTRL-EVENT-EAP-FAILURE "
  /** Scan results are ready */
  #define WPA_EVENT_SCAN_RESULTS "CTRL-EVENT-SCAN-RESULTS "
  /** wpa_supplicant state change */
  #define WPA_EVENT_STATE_CHANGE "CTRL-EVENT-STATE-CHANGE "
  /** AP to STA speed */
  #define WPA_EVENT_LINK_SPEED "CTRL-EVENT-LINK-SPEED "
  /** Driver state change */
  #define WPA_EVENT_DRIVER_STATE "CTRL-EVENT-DRIVER-STATE "
  
  /* wpa_supplicant/hostapd control interface access */
  
  /**
   * wpa_ctrl_open - Open a control interface to wpa_supplicant/hostapd
   * @ctrl_path: Path for UNIX domain sockets; ignored if UDP sockets are used.
   * Returns: Pointer to abstract control interface data or %NULL on failure
   *
   * This function is used to open a control interface to wpa_supplicant/hostapd.
   * ctrl_path is usually /var/run/wpa_supplicant or /var/run/hostapd. This path
   * is configured in wpa_supplicant/hostapd and other programs using the control
   * interface need to use matching path configuration.
   */
  struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path);
  
  
  /**
   * wpa_ctrl_close - Close a control interface to wpa_supplicant/hostapd
   * @ctrl: Control interface data from wpa_ctrl_open()
   *
   * This function is used to close a control interface.
   */
  void wpa_ctrl_close(struct wpa_ctrl *ctrl);
  
  
  /**
   * wpa_ctrl_request - Send a command to wpa_supplicant/hostapd
   * @ctrl: Control interface data from wpa_ctrl_open()
   * @cmd: Command; usually, ASCII text, e.g., "PING"
   * @cmd_len: Length of the cmd in bytes
   * @reply: Buffer for the response
   * @reply_len: Reply buffer length
   * @msg_cb: Callback function for unsolicited messages or %NULL if not used
   * Returns: 0 on success, -1 on error (send or receive failed), -2 on timeout
   *
   * This function is used to send commands to wpa_supplicant/hostapd. Received
   * response will be written to reply and reply_len is set to the actual length
   * of the reply. This function will block for up to two seconds while waiting
   * for the reply. If unsolicited messages are received, the blocking time may
   * be longer.
   *
   * msg_cb can be used to register a callback function that will be called for
   * unsolicited messages received while waiting for the command response. These
   * messages may be received if wpa_ctrl_request() is called at the same time as
   * wpa_supplicant/hostapd is sending such a message. This can happen only if
   * the program has used wpa_ctrl_attach() to register itself as a monitor for
   * event messages. Alternatively to msg_cb, programs can register two control
   * interface connections and use one of them for commands and the other one for
   * receiving event messages, in other words, call wpa_ctrl_attach() only for
   * the control interface connection that will be used for event messages.
   */
  int wpa_ctrl_request(struct wpa_ctrl *ctrl, const char *cmd, size_t cmd_len,
  		     char *reply, size_t *reply_len,
  		     void (*msg_cb)(char *msg, size_t len));
  
  
  /**
   * wpa_ctrl_attach - Register as an event monitor for the control interface
   * @ctrl: Control interface data from wpa_ctrl_open()
   * Returns: 0 on success, -1 on failure, -2 on timeout
   *
   * This function registers the control interface connection as a monitor for
   * wpa_supplicant/hostapd events. After a success wpa_ctrl_attach() call, the
   * control interface connection starts receiving event messages that can be
   * read with wpa_ctrl_recv().
   */
  int wpa_ctrl_attach(struct wpa_ctrl *ctrl);
  
  
  /**
   * wpa_ctrl_detach - Unregister event monitor from the control interface
   * @ctrl: Control interface data from wpa_ctrl_open()
   * Returns: 0 on success, -1 on failure, -2 on timeout
   *
   * This function unregisters the control interface connection as a monitor for
   * wpa_supplicant/hostapd events, i.e., cancels the registration done with
   * wpa_ctrl_attach().
   */
  int wpa_ctrl_detach(struct wpa_ctrl *ctrl);
  
  
  /**
   * wpa_ctrl_recv - Receive a pending control interface message
   * @ctrl: Control interface data from wpa_ctrl_open()
   * @reply: Buffer for the message data
   * @reply_len: Length of the reply buffer
   * Returns: 0 on success, -1 on failure
   *
   * This function will receive a pending control interface message. This
   * function will block if no messages are available. The received response will
   * be written to reply and reply_len is set to the actual length of the reply.
   * wpa_ctrl_recv() is only used for event messages, i.e., wpa_ctrl_attach()
   * must have been used to register the control interface as an event monitor.
   */
  int wpa_ctrl_recv(struct wpa_ctrl *ctrl, char *reply, size_t *reply_len);
  
  
  /**
   * wpa_ctrl_pending - Check whether there are pending event messages
   * @ctrl: Control interface data from wpa_ctrl_open()
   * Returns: 1 if there are pending messages, 0 if no, or -1 on error
   *
   * This function will check whether there are any pending control interface
   * message available to be received with wpa_ctrl_recv(). wpa_ctrl_pending() is
   * only used for event messages, i.e., wpa_ctrl_attach() must have been used to
   * register the control interface as an event monitor.
   */
  int wpa_ctrl_pending(struct wpa_ctrl *ctrl);
  
  
  /**
   * wpa_ctrl_get_fd - Get file descriptor used by the control interface
   * @ctrl: Control interface data from wpa_ctrl_open()
   * Returns: File descriptor used for the connection
   *
   * This function can be used to get the file descriptor that is used for the
   * control interface connection. The returned value can be used, e.g., with
   * select() while waiting for multiple events.
   *
   * The returned file descriptor must not be used directly for sending or
   * receiving packets; instead, the library functions wpa_ctrl_request() and
   * wpa_ctrl_recv() must be used for this.
   */
  int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl);
  
  #ifdef ANDROID
  /**
   * wpa_ctrl_cleanup() - Delete any local UNIX domain socket files that
   * may be left over from clients that were previously connected to
   * wpa_supplicant. This keeps these files from being orphaned in the
   * event of crashes that prevented them from being removed as part
   * of the normal orderly shutdown.
   */
  void wpa_ctrl_cleanup();
  #endif  /* ANDROID */
  
  #ifdef CONFIG_CTRL_IFACE_UDP
  #define WPA_CTRL_IFACE_PORT 9877
  #define WPA_GLOBAL_CTRL_IFACE_PORT 9878
  #endif /* CONFIG_CTRL_IFACE_UDP */
  
  
  #ifdef  __cplusplus
  }
  #endif
  
  #endif /* WPA_CTRL_H */
  