obus
  1. Overview
  2. Docs
package obus
Legend:
Library
Module
Module type
Parameter
Class
Class type

NetworkManager devices

include OBus_proxy.Private
type t = private OBus_proxy.proxy
val of_proxy : OBus_proxy.proxy -> t
val to_proxy : t -> OBus_proxy.proxy
Common interface
Types
type state = [
  1. | `Unknown
    (*

    The device is in an unknown state.

    *)
  2. | `Unmanaged
    (*

    The device is not managed by NetworkManager.

    *)
  3. | `Unavailable
    (*

    The device cannot be used (carrier off, rfkill, etc)

    *)
  4. | `Disconnected
    (*

    The device is not connected.

    *)
  5. | `Prepare
    (*

    The device is preparing to connect.

    *)
  6. | `Config
    (*

    The device is being configured.

    *)
  7. | `Need_auth
    (*

    The device is awaiting secrets necessary to continue connection.

    *)
  8. | `Ip_config
    (*

    The IP settings of the device are being requested and configured.

    *)
  9. | `Activated
    (*

    The device is active.

    *)
  10. | `Failed
    (*

    The device is in a failure state following an attempt to activate it.

    *)
]
type state_reason = [
  1. | `Unknown
    (*

    The reason for the device state change is unknown.

    *)
  2. | `None
    (*

    The state change is normal.

    *)
  3. | `Now_managed
    (*

    The device is now managed.

    *)
  4. | `Now_unmanaged
    (*

    The device is no longer managed.

    *)
  5. | `Config_failed
    (*

    The device could not be readied for configuration.

    *)
  6. | `Config_unavailable
    (*

    IP configuration could not be reserved (no available address, timeout, etc).

    *)
  7. | `Config_expired
    (*

    The IP configuration is no longer valid.

    *)
  8. | `No_secrets
    (*

    Secrets were required, but not provided.

    *)
  9. | `Supplicant_disconnect
    (*

    The 802.1X supplicant disconnected from the access point or authentication server.

    *)
  10. | `Supplicant_config_failed
    (*

    Configuration of the 802.1X supplicant failed.

    *)
  11. | `Supplicant_failed
    (*

    The 802.1X supplicant quit or failed unexpectedly.

    *)
  12. | `Supplicant_timeout
    (*

    The 802.1X supplicant took too long to authenticate.

    *)
  13. | `Ppp_start_failed
    (*

    The PPP service failed to start within the allowed time.

    *)
  14. | `Ppp_disconnect
    (*

    The PPP service disconnected unexpectedly.

    *)
  15. | `Ppp_failed
    (*

    The PPP service quit or failed unexpectedly.

    *)
  16. | `Dhcp_start_failed
    (*

    The DHCP service failed to start within the allowed time.

    *)
  17. | `Dhcp_error
    (*

    The DHCP service reported an unexpected error.

    *)
  18. | `Dhcp_failed
    (*

    The DHCP service quit or failed unexpectedly.

    *)
  19. | `Shared_start_failed
    (*

    The shared connection service failed to start.

    *)
  20. | `Shared_failed
    (*

    The shared connection service quit or failed unexpectedly.

    *)
  21. | `Autoip_start_failed
    (*

    The AutoIP service failed to start.

    *)
  22. | `Autoip_error
    (*

    The AutoIP service reported an unexpected error.

    *)
  23. | `Autoip_failed
    (*

    The AutoIP service quit or failed unexpectedly.

    *)
  24. | `Modem_busy
    (*

    Dialing failed because the line was busy.

    *)
  25. | `Modem_no_dial_tone
    (*

    Dialing failed because there was no dial tone.

    *)
  26. | `Modem_no_carrier
    (*

    Dialing failed because there was carrier.

    *)
  27. | `Modem_dial_timeout
    (*

    Dialing timed out.

    *)
  28. | `Modem_dial_failed
    (*

    Dialing failed.

    *)
  29. | `Modem_init_failed
    (*

    Modem initialization failed.

    *)
  30. | `Gsm_apn_failed
    (*

    Failed to select the specified GSM APN.

    *)
  31. | `Gsm_registration_not_searching
    (*

    Not searching for networks.

    *)
  32. | `Gsm_registration_denied
    (*

    Network registration was denied.

    *)
  33. | `Gsm_registration_timeout
    (*

    Network registration timed out.

    *)
  34. | `Gsm_registration_failed
    (*

    Failed to register with the requested GSM network.

    *)
  35. | `Gsm_pin_check_failed
    (*

    PIN check failed.

    *)
  36. | `Firmware_missing
    (*

    Necessary firmware for the device may be missing.

    *)
  37. | `Removed
    (*

    The device was removed.

    *)
  38. | `Sleeping
    (*

    NetworkManager went to sleep.

    *)
  39. | `Connection_removed
    (*

    The device's active connection was removed or disappeared.

    *)
  40. | `User_requested
    (*

    A user or client requested the disconnection.

    *)
  41. | `Carrier
    (*

    The device's carrier/link changed.

    *)
  42. | `Connection_assumed
    (*

    The device's existing connection was assumed.

    *)
  43. | `Supplicant_available
    (*

    The 802.1x supplicant is now available.

    *)
]
type typ = [
  1. | `Unknown
    (*

    The device type is unknown.

    *)
  2. | `Ethernet
    (*

    The device is wired Ethernet device.

    *)
  3. | `Wifi
    (*

    The device is an 802.11 WiFi device.

    *)
  4. | `Gsm
    (*

    The device is a GSM-based cellular WAN device.

    *)
  5. | `Cdma
    (*

    The device is a CDMA/IS-95-based cellular WAN device.

    *)
]
type capability = [
  1. | `Nm_supported
    (*

    The device is supported by NetworkManager.

    *)
  2. | `Carrier_detect
    (*

    The device supports carrier detection.

    *)
]
Methods
val disconnect : t -> unit Lwt.t
Signals
val state_changed : t -> (state * state * state_reason) OBus_signal.t
Properties
val udi : t -> string OBus_property.r
val interface : t -> string OBus_property.r
val driver : t -> string OBus_property.r
val capabilities : t -> capability list OBus_property.r
val ip4_address : t -> int32 OBus_property.r
val state : t -> state OBus_property.r
val ip4_config : t -> Nm_ip4_config.t OBus_property.r
val dhcp4_config : t -> Nm_dhcp4_config.t OBus_property.r
val ip6_config : t -> Nm_ip6_config.t OBus_property.r
val managed : t -> bool OBus_property.r
val device_type : t -> typ OBus_property.r
val properties : t -> OBus_property.group
Specific device interfaces
module Bluetooth : sig ... end
module Cdma : sig ... end
module Gsm : sig ... end
module Olpc_mesh : sig ... end
module Serial : sig ... end
module Wired : sig ... end
module Wireless : sig ... end