acsQoS::Timeout

acsQoS::Timeout −

#include <acsQoStimeout.h>

Public Member Functions

Timeout (unsigned long timeout)

~Timeout ()

unsigned long get ()

void set (unsigned long timeout)

Static Public Member Functions

static void setORBTimeout (unsigned long timeout, CORBA::ORB_ptr _orb=CORBA::ORB::_nil())

template<class T > static T * setObjectTimeout (unsigned long timeout, T *obj)

static void init (CORBA::ORB_ptr _orb)

static bool isInitialized ()

static void done ()

Private Member Functions

void set ()

Private Attributes

unsigned long timeout_m

CORBA::PolicyList policyList_m

CORBA::PolicyCurrent_var policyCurrent_m

CORBA::PolicyList previousPolicy_m

Static Private Attributes

static CORBA::ORB_var orb_m

static bool initialized_m

acsQoS::Timeout::Timeout (unsigned long timeout) Constructor.

Parameters:

timeout the timeout expressed in milliseconds.

acsQoS::Timeout::~Timeout () Destructor.

static void acsQoS::Timeout::done () [static] Method to ’cleanup’ the acsQoS functionality. In order to use acsQoS features such as timeouts, things must first be initialised and should also be cleaned up when such features are not needed any longer. This is normally done automatically during shutdown of the container and/or the simple client, so the user does not have to take care of this (i.e. the user does not normally need to call this method explicitly).

unsigned long acsQoS::Timeout::get () [inline] Method to get the timeout, in milliseconds.

Returns:

the timeout expressed in milliseconds.

static void acsQoS::Timeout::init (CORBA::ORB_ptr _orb) [static] Initializes the acsQoS functionality. In order to use acsQoS features such as timeouts, things must first be initialised. This is normally done automatically in the container and in the simple client, so the user does not have to take care of this (i.e. the user does not normally need to call this method explicitly).

Parameters:

_orb a reference to the ORB to be ’prepared’ or initialized in order to use QoS features.

static bool acsQoS::Timeout::isInitialized () [static] Method to check to see if the acsQoS functionality has been initialized.

Returns:

boolean indicating whether the acsQoS functionality has been initialized (true) or not (false).

void acsQoS::Timeout::set (unsigned long timeout) [inline] Method to set the timeout, in milliseconds.

Parameters:

timeout the timeout expressed in milliseconds.

void acsQoS::Timeout::set () [private]

template<class T > static T* acsQoS::Timeout::setObjectTimeout (unsigned long timeout, T * obj) [inline, static] Sets the timeout on the level of an individual CORBA object. Note that the user must use the returned object reference for invoking calls in order for the timeout be used.

Parameters:

timeout the timeout in milliseconds.
obj a CORBA object on which to set the timeout.

Returns:

pointer to the new CORBA object which can be used to invoke methods with the assigned timeout.

static void acsQoS::Timeout::setORBTimeout (unsigned long timeout, CORBA::ORB_ptr _orb = CORBA::ORB::_nil()) [static] Sets the ORB level timeout. The timeout can be set either on the orb that was passed (previously) to the init method, or on the orb that is passed as a second parameter.

Parameters:

timeout the timeout value desired expressed in milliseconds.
_orb the orb on which to set the timeout.

bool acsQoS::Timeout::initialized_m [static, private]

CORBA::ORB_var acsQoS::Timeout::orb_m [static, private]

CORBA::PolicyCurrent_var acsQoS::Timeout::policyCurrent_m [private]

CORBA::PolicyList acsQoS::Timeout::policyList_m [private]

CORBA::PolicyList acsQoS::Timeout::previousPolicy_m [private]

unsigned long acsQoS::Timeout::timeout_m [private]

Generated automatically by Doxygen for ACS-2015.2 C++ API from the source code.