TimeoutContainer Class Reference

#include <OperationContext.h>

Inheritance diagram for TimeoutContainer:
OperationContext::Container

List of all members.

Public Member Functions

 TimeoutContainer (const OperationContext::Container &container)
 TimeoutContainer (Uint32 timeout)
virtual String getName () const
virtual
OperationContext::Container
clone () const
virtual void destroy ()
Uint32 getTimeOut () const

Static Public Attributes

static const String NAME

Protected Attributes

Uint32 _value

Detailed Description

A TimeoutContainer object holds an operation timeout value, in milliseconds.


Constructor & Destructor Documentation

TimeoutContainer::TimeoutContainer ( const OperationContext::Container container  ) 

Constructs a TimeoutContainer object from the specified Container.

Parameters:
container The Container object to copy.
Exceptions:
DynamicCastFailedException If the specified Container object is not a TimeoutContainer object.
TimeoutContainer::TimeoutContainer ( Uint32  timeout  ) 

Constructs a TimeoutContainer with the specified timeout value.

Parameters:
timeout An integer timeout value (in milliseconds).

Member Function Documentation

virtual OperationContext::Container* TimeoutContainer::clone (  )  const [virtual]

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.

Implements OperationContext::Container.

virtual void TimeoutContainer::destroy (  )  [virtual]

Cleans up a TimeoutContainer object that was created by the clone() method.

Implements OperationContext::Container.

virtual String TimeoutContainer::getName (  )  const [virtual]

Returns the unique name for this Container type.

Returns:
The String name of the Container type.

Implements OperationContext::Container.

Uint32 TimeoutContainer::getTimeOut (  )  const

Gets the timeout value from the TimeoutContainer.

Returns:
An integer timeout value (in milliseconds).

Member Data Documentation

Uint32 TimeoutContainer::_value [protected]

An internal representation of the TimeoutContainer timeout value.

The unique name for this container type.


The documentation for this class was generated from the following file: