From cd4739acb0c6d1bca2d3a7adc5c52324928a5561 Mon Sep 17 00:00:00 2001 From: Alan Coopersmith Date: Thu, 21 Oct 2010 22:55:04 -0700 Subject: SMlib.xml: add internal cross-reference links Signed-off-by: Alan Coopersmith --- doc/SMlib.xml | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) (limited to 'doc') diff --git a/doc/SMlib.xml b/doc/SMlib.xml index 15a083d..3e749f5 100644 --- a/doc/SMlib.xml +++ b/doc/SMlib.xml @@ -135,7 +135,7 @@ context - A pointer to an opaque object or NULL. Used to determine if an ICE connection can be shared (see below). + A pointer to an opaque object or NULL. Used to determine if an ICE connection can be shared (see below). xsmp_major_rev @@ -207,9 +207,9 @@ Note that SMlib uses the ICE protocol to establish a connection with the session manager. If an ICE connection already exists between the client and session manager, it might be possible for the same ICE connection to be used for session management. -The context argument indicates how willing the client is to share the ICE connection with other protocols. If context is NULL, then the caller is always willing to share the connection. If context is not NULL, then the caller is not willing to use a previously opened ICE connection that has a different non-NULL context associated with it. +The context argument indicates how willing the client is to share the ICE connection with other protocols. If context is NULL, then the caller is always willing to share the connection. If context is not NULL, then the caller is not willing to use a previously opened ICE connection that has a different non-NULL context associated with it. -As previously discussed (section 3, “Understanding SMlib's Dependence on ICE”), the client will have to keep track of when ICE connections are created or destroyed (using IceAddConnectionWatch and IceRemoveConnectionWatch and will have to call IceProcessMessages each time a select shows that there is data to read on an ICE connection. For further information, see the Inter-Client Exchange Library standard. +As previously discussed (section 3, “Understanding SMlib's Dependence on ICE”), the client will have to keep track of when ICE connections are created or destroyed (using IceAddConnectionWatch and IceRemoveConnectionWatch and will have to call IceProcessMessages each time a select shows that there is data to read on an ICE connection. For further information, see the Inter-Client Exchange Library standard. The callbacks argument contains a set of callbacks used to respond to session manager events. The mask argument specifies which callbacks are set. All of the callbacks specified in this version of SMlib are mandatory. The mask argument is necessary in order to maintain backwards compatibility in future versions of the library. @@ -392,7 +392,7 @@ typedef struct { -The session manager sends a “Shutdown Cancelled” message when the user cancelled the shutdown during an interaction (see section 5.5, “Interacting With the User”). The client can now continue as if the shutdown had never happened. If the client has not called SmcSaveYourselfDone yet, it can either abort the save and then call SmcSaveYourselfDone with the success argument set to False or it can continue with the save and then call SmcSaveYourselfDone with the success argument set to reflect the outcome of the save. +The session manager sends a “Shutdown Cancelled” message when the user cancelled the shutdown during an interaction (see section 5.5, “Interacting With the User”). The client can now continue as if the shutdown had never happened. If the client has not called SmcSaveYourselfDone yet, it can either abort the save and then call SmcSaveYourselfDone with the success argument set to False or it can continue with the save and then call SmcSaveYourselfDone with the success argument set to reflect the outcome of the save. @@ -509,7 +509,7 @@ typedef struct { The properties are specified as an array of property pointers. Previously set property values may be over-written using the SmcSetProperties function. Note that the session manager is not expected to restore property values when the session is restarted. Because of this, clients should not try to use the session manager as a database for storing application specific state. -For a description of session management properties and the SmProp structure, see section 7, “Session Management Properties.” +For a description of session management properties and the SmProp structure, see section 7, “Session Management Properties.” To delete properties previously set by the client, use SmcDeleteProperties @@ -596,7 +596,7 @@ typedef struct { -To free each property, use SmFreeProperty (see section 8, “Freeing Data”). To free the actual array of pointers, use free +To free each property, use SmFreeProperty (see section 8, “Freeing Data”). To free the actual array of pointers, use free @@ -728,7 +728,7 @@ typedef struct { -The save_type, shutdown, interact_style, and fast arguments are discussed in more detail in section 5.1.1, “The Save Yourself Callback.” +The save_type, shutdown, interact_style, and fast arguments are discussed in more detail in section 5.1.1, “The Save Yourself Callback.” If global is set to True then the resulting “Save Yourself” should be sent to all clients in the session. For example, a vendor of a Uninterruptible Power Supply (UPS) might include a Session Management client that would monitor the status of the UPS and generate a fast shutdown if the power is about to be lost. @@ -995,7 +995,7 @@ typedef struct { After the SmsInitialize function is called, the session manager should call the IceListenForConnections function to listen for new connections. Afterwards, each time a client connects, the session manager should call IceAcceptConnection -See section 9, “Authentication of Clients,” for more details on authentication (including host based authentication). Also see the Inter-Client Exchange Library standard for further details on listening for and accepting ICE connections. +See section 9, “Authentication of Clients,” for more details on authentication (including host based authentication). Also see the Inter-Client Exchange Library standard for further details on listening for and accepting ICE connections. Each time a new client connects to the session manager, the SmsNewClientProc callback is invoked. The session manager obtains a new opaque connection object that it should use for all future interaction with the client. At this time, the session manager must also register a set of callbacks to respond to the different messages that the client might send. @@ -1268,7 +1268,7 @@ If the client is first joining the session, previous_id will be NULL. -The Save Yourself Request prompts the session manager to initiate a checkpoint or shutdown. For information on the save_type, shutdown, interact_style, and fast arguments, see section 6.3, “Sending a Save Yourself Message.” +The Save Yourself Request prompts the session manager to initiate a checkpoint or shutdown. For information on the save_type, shutdown, interact_style, and fast arguments, see section 6.3, “Sending a Save Yourself Message.” If global is set to True then the resulting “Save Yourself” should be sent to all applications. If global is set to False then the “Save Yourself” should only be sent to the client that requested it. @@ -1367,7 +1367,7 @@ If the client is first joining the session, previous_id will be NULL. The reason_msgs argument will most likely be NULL and the count argument zero (0) if resignation is expected by the user. Otherwise, it contains a list of null-terminated Compound Text strings representing the reason for termination. The session manager should display these reason messages to the user. -Call SmFreeReasons to free the reason messages. For further information, see section 8, “Freeing Data.” +Call SmFreeReasons to free the reason messages. For further information, see section 8, “Freeing Data” @@ -1403,11 +1403,11 @@ If the client is first joining the session, previous_id will be NULL. -The properties are specified as an array of property pointers. For a description of session management properties and the SmProp structure, see section 7, “Session Management Properties.” +The properties are specified as an array of property pointers. For a description of session management properties and the SmProp structure, see section 7, “Session Management Properties.” Previously set property values may be over-written. Some properties have predefined semantics. The session manager is required to store nonpredefined properties. -To free each property, use SmFreeProperty For further information, see section 8, “Freeing Data.” You should free the actual array of pointers with a call to free +To free each property, use SmFreeProperty For further information, see section 8, “Freeing Data” You should free the actual array of pointers with a call to free @@ -1444,7 +1444,7 @@ If the client is first joining the session, previous_id will be NULL. -The properties are specified as an array of strings. For a description of session management properties and the SmProp structure, see section 7, “Session Management Properties.” +The properties are specified as an array of strings. For a description of session management properties and the SmProp structure, see section 7, “Session Management Properties.” @@ -1718,13 +1718,13 @@ If the client is first joining the session, previous_id will be NULL. -The properties are returned as an array of property pointers. For a description of session management properties and the SmProp structure, see section 7, “Session Management Properties.” +The properties are returned as an array of property pointers. For a description of session management properties and the SmProp structure, see section 7, “Session Management Properties.” Pinging a Client -To check that a client is still alive, you should use the IcePing function provided by the ICE library. To do so, the ICE connection must be obtained using the SmsGetIceConnection (see section 6.12, “Using Sms Informational Functions”). +To check that a client is still alive, you should use the IcePing function provided by the ICE library. To do so, the ICE connection must be obtained using the SmsGetIceConnection (see section 6.12, “Using Sms Informational Functions”). -- cgit v1.2.1