diff -r 7685cec9fd3c -r f2ddfa555b0f doc/api/python/nokia.nokiaccm-module.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/api/python/nokia.nokiaccm-module.html Fri Sep 11 11:54:49 2009 +0100 @@ -0,0 +1,224 @@ + + + + + nokia.nokiaccm + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + Package nokia :: + Module nokiaccm + + + + + + +
[hide private]
[frames] | no frames]
+
+ +

Module nokiaccm

source code

+Nokia specific interface to Synergy sessions.

+ + + + + + + + + + +
+ + + + + +
Functions[hide private]
+
+   + + + + + + +
open_session(username=None, + password=None, + engine=None, + dbpath=None, + database=None, + reuse=True)
+ Provides a Session object.
+ source code + +
+ +
+ + + + + + + + + +
+ + + + + +
Variables[hide private]
+
+   + + _logger = logging.getLogger("nokia.nokiaccm") +
+ + + + + + +
+ + + + + +
Function Details[hide private]
+
+ +
+ +
+ + +
+

open_session(username=None, + password=None, + engine=None, + dbpath=None, + database=None, + reuse=True) +

+
source code  +
+ +

Provides a Session object.

+

Attempts to return a Session, based either on existing Synergy +sessions or by creating a new one.

+
    +
  • If a .netrc file can be found on the user's personal drive, +that will be read to obtain Synergy login information if it +is defined there. This will be used to fill in any missing +parameters not passed in the call to open_session().

    +

    The format of the .netrc file entries should be:

    +

    machine synergy login USERNAME password foobar account DATABASE_PATH@SERVER

    +

    If the details refer to a specific database, the machine can be the database name, +instead of "synergy".

    +
  • +
  • If an existing session is running that matches the supplied +parameters, it will reuse that.

    +
  • +
+
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + +
+ + + + +