Session Manager Service - Revision history

Paulb: Set attchement marks in examples

2008-10-29T17:07:44Z

Set attchement marks in examples

Paulb: Corrected example

2008-10-29T17:06:22Z

Corrected example

Paulb: /* Retrieving Sessions */

2007-12-12T01:30:03Z

‎Retrieving Sessions

Paulb: /* Retrieving Sessions */

2007-12-12T01:29:34Z

‎Retrieving Sessions

Paulb: /* Session Data Identifier Recommendations */

2007-12-03T23:56:13Z

‎Session Data Identifier Recommendations

Paulb: /* Using Sessions */

2007-12-03T23:55:45Z

‎Using Sessions

Paulb: /* Sessions and Aggregated Sessions */

2007-12-03T19:44:10Z

‎Sessions and Aggregated Sessions

Paulb: /* Sessions and Aggregated Sessions */

2007-12-03T19:43:11Z

‎Sessions and Aggregated Sessions

Paulb: /* Retrieving Sessions */

2007-11-30T00:55:28Z

‎Retrieving Sessions

Paulb: /* Receiving Session Data Value Change Notification */

2007-11-30T00:55:02Z

‎Receiving Session Data Value Change Notification

@@ Line 26: / Line 26: @@
 The following code retrieves a session for the environment:
 <eiffel>
-environment_session: SESSION_I
+environment_session: ?SESSION_I
      -- Retrieve the environment (IDE) session.
    local
-     l_sm: SERVICE_CONSUMER [SESSION_MANAGER_S]
+     l_sm: !SERVICE_CONSUMER [SESSION_MANAGER_S]
    do
      create l_consumer
@@ Line 80: / Line 80: @@
    end
-my_data_id: STRING_8 = "com.eiffel.tool.my_data"
+my_data_id: !STRING = "com.eiffel.tool.my_data"
      -- Session data id
 </eiffel>
@@ Line 92: / Line 92: @@
      -- Access to my data.
    do
-     if {ref: !INTEGER_REF} session_data.value (my_data_id) then
+     if {ref: INTEGER_REF} session_data.value (my_data_id) then
        Result := ref.item
      else

@@ Line 120: / Line 120: @@
      -- Access to my data.
    do
-      Result ?= session_data.value_or_default (my_data_id, 10)
+    Result := session_data.value_or_default (my_data_id, 10)
-    end
    end
 </eiffel>

@@ Line 20: / Line 20: @@
 == Retrieving Sessions ==
-In order to work with a session, represented by a [https://svn.eiffel.com/eiffelstudio/trunk/Src/Eiffel/API/framework/ecosystem/services/session/session_i.e SESSION_I] interface, you will need to query for the session manager service. This can be done using a [[Service#Service Consumers|service consumer]] or via accessible [[Services#Service_Provider|service provider]].
+In order to work with a session, represented by a [https://svn.eiffel.com/eiffelstudio/trunk/Src/Eiffel/API/framework/ecosystem/services/session/session_i.e SESSION_I] interface, you will need to query for the session manager service. This can be done using a [[Service Consumers|service consumer]] or via accessible [[Services#Service_Provider|service provider]].
 There are only two function exposed on the session manager service for retrieving a session, and are used depending on what [[Session_Manager_Service#Determining_the_Type_of_Session|type of session]] needed to be retrieved; <eiffel>retrieve</eiffel> and <eiffel>retrieve_per_window</eiffel>. <eiffel>retrieve</eiffel> will retrieve an environment or project-level sessions where as <eiffel>retrieve_per_window</eiffel> is used to retrieve window or project/window-level sessions. <eiffel>retrieve_per_window</eiffel> requires an additional argument specifying the window to retrieve a session for.

@@ Line 20: / Line 20: @@
 == Retrieving Sessions ==
-In order to work with a session, represented by a [https://svn.eiffel.com/eiffelstudio/trunk/Src/Eiffel/API/framework/ecosystem/services/session/session_i.e SESSION_I] interface, you will need to query for the session manager service. This can be done using a [[Service#Service_consumer|service consumer]] or via accessible [[Services#Service_Provider|service provider]].
+In order to work with a session, represented by a [https://svn.eiffel.com/eiffelstudio/trunk/Src/Eiffel/API/framework/ecosystem/services/session/session_i.e SESSION_I] interface, you will need to query for the session manager service. This can be done using a [[Service#Service Consumers|service consumer]] or via accessible [[Services#Service_Provider|service provider]].
 There are only two function exposed on the session manager service for retrieving a session, and are used depending on what [[Session_Manager_Service#Determining_the_Type_of_Session|type of session]] needed to be retrieved; <eiffel>retrieve</eiffel> and <eiffel>retrieve_per_window</eiffel>. <eiffel>retrieve</eiffel> will retrieve an environment or project-level sessions where as <eiffel>retrieve_per_window</eiffel> is used to retrieve window or project/window-level sessions. <eiffel>retrieve_per_window</eiffel> requires an additional argument specifying the window to retrieve a session for.

@@ Line 53: / Line 53: @@
 ==== Session Data Identifier Recommendations ====
-There is not absolute rules to declaring a session data identifier except that is must be a non-empty attached string object. However to ensure uniqueness the following rules should be adhered to:
+There are no absolute rules to declaring a session data identifier except that is must be a non-empty attached string object. However to ensure uniqueness the following rules should be adhered to:
 And id should...

@@ Line 47: / Line 47: @@
 == Using Sessions ==
-Sessions are utilized through a [[#Retrieving Sessions|retrieve]] [https://svn.eiffel.com/eiffelstudio/trunk/Src/Eiffel/API/framework/ecosystem/services/session/session_i.e SESSION_I] object interface. It's through the session object interface clients can retrieve or set session data. All session data interaction is performed using a session data identifier.
+Sessions are utilized through a [[#Retrieving Sessions|retrieved]] [https://svn.eiffel.com/eiffelstudio/trunk/Src/Eiffel/API/framework/ecosystem/services/session/session_i.e SESSION_I] object interface. It's through the session object interface clients can retrieve or set session data. All session data interaction is performed using a session data identifier.
 === Session Data Identifiers ===

@@ Line 15: / Line 15: @@
 Here is a brief run through of the level of data that can be read by a type of session:
 * A environment-level session will only provide session data exposed in the environment session.
-* A project-level session will provide session data exposed in the environment session.
+* A project-level session will additionally provide session data exposed in the environment session.
-* A window-level session will provide session data exposed in the environment session.
+* A window-level session will additionally provide session data exposed in the environment session.
-* A project and window level session will provide session data exposed in the window session and then session data exposed in the environment session.
+* A project and window level session will additionally provide session data exposed in the window session and then session data exposed in the environment session.
 == Retrieving Sessions ==

@@ Line 11: / Line 11: @@
 === Sessions and Aggregated Sessions ===
-Sessions come in four flavors, with each session being distinct. This could be a hassle for anyone wishing to access multiple session data, such as both the environment as well as project-level data. Fortunately most of the session data objects are aggregated to support retrieval of session data for a higher, wider scoped session. The only session that is no aggregated is the environment session as there is no wider scope that the [[EiffelStudio]] environment itself, which encompasses all opened windows.
+Sessions come in four flavors, with each session being distinct. This could be a hassle for anyone wishing to access multiple session data, such as both the environment as well as project-level data. Fortunately most of the session data objects are aggregated to support retrieval of session data for a higher, wider scoped session. The only session that is not aggregated is the environment session as there is no wider scope that the [[EiffelStudio]] environment itself, which encompasses all opened windows.
 Here is a brief run through of the level of data that can be read by a type of session:

@@ Line 42: / Line 42: @@
 When retrieving project-level sessions there is no need for a attached project object to be supplied, the reason is two fold: ('''1''') [[EiffelStudio]] currently only supports a single project loaded at any one time and ('''2''') it may be necessary to retrieve a project-level session before the project is loaded. The internals of a project session will ensure that once a project is loaded the session data is set and the appropriate events are fired.
-{{Note|Although it is possible to retrieve a project-level session before a project is loaded, the session data will not be respective of the last persisted project. Until a project is loaded there is no way for the session manager to determine which project session data should be retrieved for. Once a project is loaded any project-level sessions will be updated with the loaded project session data. Clients can receive notification of this by subscribing to the [[#Receiving Change Notifications|value changed events]].}}
+{{Note|Although it is possible to retrieve a project-level session before a project is loaded, the session data will not be respective of the last persisted project. Until a project is loaded there is no way for the session manager to determine which project session data should be retrieved for. Once a project is loaded any project-level sessions will be updated with the loaded project session data. Clients can receive notification of this by subscribing to the [[#Receiving Session Data Value Change Notification|value changed events]].}}
 For [[Tool_Integration_Development|tool developers]], [http://link ES_DOCKABLE_TOOL_WINDOW] already exposes access to both environment and window-level session objects via <eiffel>session_data</eiffel> and <eiffel>window_session_data</eiffel> respectively.

← Older revision		Revision as of 00:55, 30 November 2007
Line 136:		Line 136:

	Session data objects should also no reference any pointers from either external or internal resources. Resurrected pointers will likely point to an illegal, uninitialized memory location causing a segmentation violation when used.		Session data objects should also no reference any pointers from either external or internal resources. Resurrected pointers will likely point to an illegal, uninitialized memory location causing a segmentation violation when used.
		+
		+	=== Receiving Session Data Value Change Notification ===
		+	Session objects can be shared amongst many parts of the [[EiffelStudio]] IDE and those parts may shared common session data. When a session's session data value changes those parts using a session may need to receive notification of the change. Each session exposes <eiffel>value_changed_events</eiffel> for clients to subscribe to, to receive change notifications and explicitly publish changes. Any differing session data value set on a session object will automatically publish the value changed event and notify any subscribers of the change.
		+
		+	{{Note\|If any changes are made to attributes on an actual session data value object, and not the session data value itself, clients making the changes should publish the value changed event, for associate the session data object, explicitly as there is no way for the service manager receive automatic notification. This is important as clients may be interested in the change.}}

	=== Determining the Type of Session ===		=== Determining the Type of Session ===