Contents
|
In file ../../src/Pegasus/Common/OperationContext.h:
A TimeoutContainer object holds an operation timeout value, in milliseconds
Documentation
A TimeoutContainer object holds an operation timeout value, in
milliseconds
Inheritance:
Public Fields
static const String | NAME
The unique name for this container type
|
Public Methods
| TimeoutContainer (const OperationContext::Container& container)
Constructs a TimeoutContainer object from the specified Container.
|
| TimeoutContainer (Uint32 timeout)
Constructs a TimeoutContainer with the specified timeout value.
|
virtual String | getName () const
Returns the unique name for this Container type.
|
virtual OperationContext::Container* | clone () const
Makes a copy of this TimeoutContainer object.
|
virtual void | destroy ()
Cleans up a TimeoutContainer object that was created by the clone() method
|
Uint32 | getTimeOut () const
Gets the timeout value from the TimeoutContainer.
|
Protected Fields
Uint32 | _value
An internal representation of the TimeoutContainer timeout value
|
- static const String NAME
-
The unique name for this container type
- TimeoutContainer(const OperationContext::Container& container)
-
Constructs a TimeoutContainer object from the specified Container.
- Throws:
- DynamicCastFailedException If the specified Container
object is not a TimeoutContainer object.
- Parameters:
- container - The Container object to copy.
- TimeoutContainer(Uint32 timeout)
-
Constructs a TimeoutContainer with the specified timeout value.
- Parameters:
- timeout - An integer timeout value (in milliseconds).
- virtual String getName() const
-
Returns the unique name for this Container type.
- Returns:
- The String name of the Container type.
- virtual OperationContext::Container* clone() const
-
Makes a copy of this TimeoutContainer object. The caller is
responsible for cleaning up the copy by calling destroy() method.
- Returns:
- A pointer to the new Container object.
- virtual void destroy()
-
Cleans up a TimeoutContainer object that was created by the clone()
method
- Uint32 getTimeOut() const
-
Gets the timeout value from the TimeoutContainer.
- Returns:
- An integer timeout value (in milliseconds).
- Uint32 _value
-
An internal representation of the TimeoutContainer timeout value
- This class has no child classes.
Alphabetic index HTML hierarchy of classes or Java
|