summaryrefslogtreecommitdiff
path: root/api/franca/navigation/mapviewer/Session.fidl
diff options
context:
space:
mode:
authorasanoaozora <fifitaneki@hotmail.com>2016-08-30 01:49:09 +0200
committerasanoaozora <fifitaneki@hotmail.com>2016-08-30 01:49:09 +0200
commit4ef8d02cc047d7eac8f761f1a8fc8d3f54bcd23e (patch)
tree44406893df759fc57a5caa6403f67c4c16643605 /api/franca/navigation/mapviewer/Session.fidl
parent1cfa51e76ba173166c113eccf6a61a5904ff7e7d (diff)
downloadpoi-service-4ef8d02cc047d7eac8f761f1a8fc8d3f54bcd23e.tar.gz
add error messages to Franca files
Diffstat (limited to 'api/franca/navigation/mapviewer/Session.fidl')
-rw-r--r--api/franca/navigation/mapviewer/Session.fidl18
1 files changed, 16 insertions, 2 deletions
diff --git a/api/franca/navigation/mapviewer/Session.fidl b/api/franca/navigation/mapviewer/Session.fidl
index 23828ee..9fbe92e 100644
--- a/api/franca/navigation/mapviewer/Session.fidl
+++ b/api/franca/navigation/mapviewer/Session.fidl
@@ -8,6 +8,7 @@ package org.genivi.navigation.mapviewer
import org.genivi.CommonTypes.* from "../../CommonTypes.fidl"
import org.genivi.navigation.NavigationTypes.* from "../NavigationTypes.fidl"
+import org.genivi.navigation.mapviewer.MapViewerTypes.* from "./MapViewerTypes.fidl"
<** @description : This interface offers methods that implement the navigation core session functionality of a navigation system.**>
@@ -25,7 +26,9 @@ interface Session {
}
}
- <** @description : createSession = This method creates a new session and retrieves a handle .**>
+ <** @description : createSession = This method creates a new session and retrieves a handle .
+ notify(SESSION_ERROR_NOMORESESSIONHANDLES) is emitted if no more session handles are available
+ **>
method createSession {
in {
<**
@@ -42,7 +45,9 @@ interface Session {
}
}
- <** @description : deleteSession = This method deletes a session and its associated resources .**>
+ <** @description : deleteSession = This method deletes a session and its associated resources .
+ notify(SESSION_ERROR_SESSIONNOTAVAILABLE) is emitted if an application tries to delete a session handle that is not available
+ **>
method deleteSession {
in {
<** @description : sessionHandle **>
@@ -78,5 +83,14 @@ interface Session {
Handle sessionHandle
}
}
+
+ <**
+ @description : notify = This signal is emitted when something wrong occured when invoking the API
+ **>
+ broadcast notify {
+ out {
+ Notification notification
+ }
+ }
}