X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=doc%2Fmanager-api.txt;h=3bd201df168856ac26fd20700b38edfef4b10b6e;hb=230905c20905f2bc5ccf4b8fab75c1b5df2ac31d;hp=20ceb7030173dccfd23dfe546316729a15035b46;hpb=07a94078b2555852355b10f56c28da55d4fe74dc;p=framework%2Fconnectivity%2Fconnman.git diff --git a/doc/manager-api.txt b/doc/manager-api.txt index 20ceb70..3bd201d 100644 --- a/doc/manager-api.txt +++ b/doc/manager-api.txt @@ -1,8 +1,8 @@ Manager hierarchy ================= -Service org.moblin.connman -Interface org.moblin.connman.Manager +Service net.connman +Interface net.connman.Manager Object path / Methods dict GetProperties() @@ -22,54 +22,14 @@ Methods dict GetProperties() Possible Errors: [service].Error.InvalidArguments [service].Error.InvalidProperty - string GetState() + array{object,dict} GetTechnologies() - Return global connection state of a system. The - same value is return via the State property. + Returns a list of tuples with technology object + path and dictionary of technology properties. Possible Errors: [service].Error.InvalidArguments - object CreateProfile(string name) - - Create and add new profile with the specified - identifier name. - - Possible Errors: [service].Error.InvalidArguments - - void RemoveProfile(object path) - - Remove profile with specified object path. - - It is not possible to remove the current active - profile. To remove the active profile a different - one must be selected via ActiveProfile property - first. - - At minimum one profile must be available all the time. - - Possible Errors: [service].Error.InvalidArguments - - void RequestScan(string type) - - Request to trigger a scan for the specified - technology. The empty string "" triggers scanning - on all technologies. - - Possible Errors: [service].Error.InvalidArguments - - void EnableTechnology(string type) - - Enable specified type of technologies. - - Possible Errors: [service].Error.InvalidArguments - - void DisableTechnology(string type) - - Disable specified type of technologies. - - Possible Errors: [service].Error.InvalidArguments - - arracy{object,dict} GetServices() + array{object,dict} GetServices() Returns a sorted list of tuples with service object path and dictionary of service properties. @@ -79,42 +39,25 @@ Methods dict GetProperties() Possible Errors: [service].Error.InvalidArguments - object LookupService(string pattern) - - Lookup a service matching the specific pattern. + object ConnectProvider(dict provider) - Examples are interface names like "eth0", "wlan0" - etc. or service names like "hotspot" etc. - - In case of multiple services match the the pattern - an error is returned. - - Possible Errors: [service].Error.InvalidArguments - [service].Error.NotUnique - [service].Error.NotFound - - object ConnectService(dict network) - - Connect to a network specified by the given + Connect to a VPN specified by the given provider properties. - For connecting to a hidden WiFi network for example - it is required that Type = "wifi" and the SSID - properties are provided. - - When successful this method will return object - path of the service object. + When successful this method will return the object + path of the VPN service object. This method can also be used to connect to an - already existing service. It works exactly the - same as executing the Connect method from the - service interface. + already existing VPN. This method call will only return in case of an error or when the service is fully connected. So setting a longer D-Bus timeout might be a really good idea. + When 'SessionMode' property is enabled, this method + call is disallowed. + Possible Errors: [service].Error.InvalidArguments void RegisterAgent(object path) @@ -129,7 +72,7 @@ Methods dict GetProperties() Possible Errors: [service].Error.InvalidArguments - void RegisterCounter(object path, uint32 accuracy, uint32 period) + void RegisterCounter(object path, uint32 accuracy, uint32 period) [experimental] Register a new counter for user notifications. @@ -150,73 +93,123 @@ Methods dict GetProperties() Possible Errors: [service].Error.InvalidArguments - void UnregisterCounter(object path) + void UnregisterCounter(object path) [experimental] Unregister an existing counter. Possible Errors: [service].Error.InvalidArguments - object RequestSession(string bearer) + object CreateSession(dict settings, object notifier) [experimental] - Request a networking session. + Create a new session for the application. Every + application can create multiple session with + different settings. The settings are described + as part of the session interface. - If the bearer is an empty string the best available - service will be picked. + The notifier allows asynchronous notification about + session specific changes. These changes can be + for online/offline state or IP address changes or + similar things the application is required to + handle. - When successful this method will return the object - path of the corresponding service. + Every application should at least create one session + to inform about its requirements and it purpose. + + void DestroySession(object session) [experimental] + + Remove the previously created session. + + If an application exits unexpectatly the session + will be automatically destroyed. + + object path, dict, fd RequestPrivateNetwork(dict options) + [experimental] + + Request a new Private Network, which includes the + creation of a tun/tap interface, and IP + configuration, NAT and IP forwarding on that + interface. + An object path, a dictionnary and a file descriptor + with IP settings are returned. Possible Errors: [service].Error.InvalidArguments + [service].Error.NotSupported - void ReleaseSession() + void ReleasePrivateNetwork(object path) [experimental] - Release a networking session. + Releases a private network. Possible Errors: [service].Error.InvalidArguments -Signals PropertyChanged(string name, variant value) +Signals TechnologyAdded(object path, dict properties) - This signal indicates a changed value of the given - property. + Signal that is sent when a new technology is added. - StateChanged(string state) + It contains the object path of the technology and + also its properties. - This signal is similar to the PropertyChanged signal - for the State property. + TechnologyRemoved(object path) - It exists for application state only care about the - current state and so can avoid to be woken up when - other details changes. + Signal that is sent when a modem has been removed. -Properties string State [readonly] + The object path is no longer accessible after this + signal and only emitted for reference. - The global connection state of a system. Possible - values are "online" if at least one connection exists - and "offline" if no device is connected. + ServicesChanged(array{object, dict}, array{object}) - In certain situations the state might change to - the value "connected". This can only be seen if - previously no connection was present. + Signals a list of services that have been changed + via the first array. And a list of service that + have been removed via the second array. - array{string} AvailableTechnologies [readonly] + The list of added services is sorted. The dictionary + with the properties might be empty in case none of + the properties have changed. Or only contains the + properties that have changed. - The list of available technologies. The strings - are the same as the ones from the service types. + For newly added services the whole set of properties + will be present. - array{string} EnabledTechnologies [readonly] + The list of removed services can be empty. - The list of enabled technologies. The strings - are the same as the ones from the service types. + This signal will only be triggered when the sort + order of the service list or the number of services + changes. It will not be emitted if only a property + of the service object changes. For that it is + required to watch the PropertyChanged signal of + the service object. - array{string} ConnectedTechnologies [readonly] + PropertyChanged(string name, variant value) - The list of connected technologies. The strings - are the same as the ones from the service type. + This signal indicates a changed value of the given + property. - string DefaultTechnology [readonly] +Properties string State [readonly] - The current connected technology which holds the - default route. + The global connection state of a system. Possible + values are "offline", "idle", "ready" and "online". + + If the device is in offline mode, the value "offline" + indicates this special global state. It can also be + retrieved via the OfflineMode property, but is kept + here for consistency and to differentiate from "idle". + + However when OfflineMode property is true, the State + property can still be "idle", "ready" or "online" + since it is possible by the end user to re-enable + individual technologies like WiFi and Bluetooth while + in offline mode. + + The states "idle", "ready" and "online" match to + states from the services. If no service is in + either "ready" or "online" state it will indicate + the "idle" state. + + If at least one service is in "ready" state and no + service is in "online" state, then it will indicate + the "ready" state. + + When at least one service is in "online" state, + this property will indicate "online" as well. boolean OfflineMode [readwrite] @@ -231,37 +224,11 @@ Properties string State [readonly] the limited usage of WiFi or Bluetooth devices might be allowed in some situations. - boolean Tethering [readwrite] - - This option allows to enable or disable the support - for tethering. When tethering is enabled then the - default service is bridged to all client where - connection sharing is supported. - - object ActiveProfile [readwrite] - - Object path of the current active profile. - - array{object} Profiles [readonly] - - List of profile object paths. - - array{object} Technologies [readonly] - - List of technology object paths. - - array{object} Services [readonly] - - List of service object paths. The list is sorted - internally to have the service with the default - route always first and then the favorite services - followed by scan results. + boolean SessionMode [readwrite] [experminental] - This list represents the available services for the - current selected profile. If the profile gets changed - then this list will be updated. + This disables the auto connect feature. It should be + enabled when the Session API is used. When SessionMode + is enabled, 'ConnectService' and 'ConnectProvider' + method calls are disallowed. - The same list is available via the profile object - itself. It is just provided here for convenience of - applications only dealing with the current active - profile. + The default value is false.