Acspy.Common.QoS
index
/alma/ACS-2016.6/ACSSW/lib/python/site-packages/Acspy/Common/QoS.py

Python ACS QoS class(es) and functions: Timeout

 
Classes
       
__builtin__.object
Timeout

 
class Timeout(__builtin__.object)
    Timeout is nearly identical to the C++ Timeout class (acsQoS module). 
However, it does not work properly at the present time, because there is 
not proper support from the python orb (OmniORB). For example, setting a 
timeout with the Timeout object will (re)set the timeout of the ORB, which
also affects method calls in other threads (undesirable side effect). For 
this reason, it is currently recommanded to use (re)setObjectTimeout 
    which sets a timeout that affects calls to just that one CORBA object.
 
  Methods defined here:
__del__(self)
The destructor for the Timeout object.
__init__(self, timeout)
The constructor for the Timeout object, which sets the timeout.
 
Parameters:
- timeout the timeout in milliseconds (a long).
 
Returns: Nothing
 
Raises: Nothing
get(self)
Returns the timeout value (expressed in milliseconds).
 
Parameters: None
 
Returns: timeout, the timeout value expressed in milliseconds.
 
Raises: Nothing
reset(self)
Resets the timeout (presently forces it to zero). 
It should work in such a way that it resets the timeout 
to the previous value, but the orb implementation does 
not support functionality to retrieve the previously set timeout.
So it sets timeout to 0 which means no timeout.
 
Parameters: Nothing
 
Returns: Nothing
 
Raises: Nothing
set(self, timeout=0)
Sets the timeout value.
 
Parameters:
- timeout the timeout to be set (a long), expressed in milliseconds.
 
Returns: Nothing
 
Raises: Nothing
sset(self)
Sets object's timeout
 
Parameters: Nothing
 
Returns: Nothing
 
Raises: Nothing

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
Functions
       
resetORBTimeout()
Resets (to zero) the ORB timeout, affecting all method invocations within 
the ORB (sets to no timeout).
resetObjectTimeout(objref)
Resets the timeout (to zero) for calls to the given CORBA object (sets to
no timeout).
setClientCallTimeout(...)
setClientCallTimeout(millisecs)
setClientCallTimeout(objref, millisecs)
 
Set the global client call timeout, or set the timeout for a specific
object reference.
setClientThreadCallTimeout(...)
setClientThreadCallTimeout(millisecs)
 
Set the client call timeout for the calling thread.
setORBTimeout(timeout)
Sets the timeout (in milliseconds) at the ORB level, affecting all method 
invocations within the ORB.
setObjectTimeout(objref, timeout)
Sets timeout (in milliseconds) on the given CORBA object. Future calls on 
the CORBA object will have this timeout, receiving an exception if the call
takes longer than the timeout value.

 
Data
        __revision__ = '$Id: QoS.py,v 1.1.1.1 2012/03/07 17:40:45 acaproni Exp $'