pyuaf.client.sessionstates

This module defines the session states, from the point of view of the client.

• Attributes:

  sessionstates.Disconnected = 0

  The session was disconnected by the user on the client side. A disconnected session may be “cleaned up” automatically by the UAF.

  sessionstates.Connected = 1

  The session is established, and is in a healthy state.

  sessionstates.ConnectionWarningWatchdogTimeout = 2

  There was a watchdog timeout, indicating a potential connection problem. When this state is active, the UAF will try to re-establish the connection.

  sessionstates.ConnectionErrorApiReconnect = 3

  The UAF client is trying to reconnect after a connection problem.

  sessionstates.ServerShutdown = 4

  The UAF client is trying to reconnect after the server announced its shutdown.

  sessionstates.NewSessionCreated = 5

  A new session has been created since the old one could not be reused.

• Functions:

  pyuaf.client.sessionstates.toString(sessionState)

  Get a string representation of the session state.

  Parameters:sessionState (int) – The session state, e.g. pyuaf.client.sessionstates.ServerShutdown. Returns:The name of the session state, e.g. ‘ServerShutdown’. Return type:str