acsQoStimeout.h

Go to the documentation of this file.

#ifndef _acsQoS_TimeOut_H_
#define _acsQoS_TimeOut_H_
/*******************************************************************************
* ALMA - Atacama Large Millimiter Array
* (c) European Southern Observatory, 2004 
*
*This library is free software; you can redistribute it and/or
*modify it under the terms of the GNU Lesser General Public
*License as published by the Free Software Foundation; either
*version 2.1 of the License, or (at your option) any later version.
*
*This library is distributed in the hope that it will be useful,
*but WITHOUT ANY WARRANTY; without even the implied warranty of
*MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
*Lesser General Public License for more details.
*
*You should have received a copy of the GNU Lesser General Public
*License along with this library; if not, write to the Free Software
*Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
*
* "@(#) $Id: acsQoStimeout.h,v 1.7 2006/02/10 20:41:03 sharring Exp $"
*
* who       when      what
* --------  --------  ----------------------------------------------
* bjeram  2004-08-24  created
*/

/************************************************************************
 *
 *----------------------------------------------------------------------
 */

#ifndef __cplusplus
#error This is a C++ include file and cannot be used from plain C
#endif

#include "tao/Messaging/Messaging.h"
#include "acsQoSErrType.h" // error stuff

namespace acsQoS
{

class Timeout
{
        public:

                Timeout(unsigned long timeout);
    
                ~Timeout();
    
                unsigned long get() { return timeout_m; }
    
                void set(unsigned long timeout) { timeout_m = timeout; set(); }
  
                static void setORBTimeout(unsigned long timeout, CORBA::ORB_ptr _orb =  CORBA::ORB::_nil());

                template <class T>
                static T* setObjectTimeout(unsigned long timeout, T *obj)
                {
                        try
                        {
                                //convert to 100's of nsecs (needed by TimeT). This calculation may seem 
                                // confusing at first, but think about it this way: one millisecond equals how many
                                // "hundreds of nanoseconds". The answer is: ten thousand milliseconds is equivalent
                                // to a single hundred of nanosecs, so we multiply by 10000 to convert from milliseconds to 100 of ns.
                                // Still confused? Then grab a pencil and paper to convince yourself.
                                TimeBase::TimeT to = timeout * 10000;    
                                CORBA::Any anyTimeOut;
                                anyTimeOut <<= to;
    
                                CORBA::PolicyList policyList;
                                policyList.length (1);
                                policyList[0] = orb_m->create_policy (Messaging::RELATIVE_RT_TIMEOUT_POLICY_TYPE, anyTimeOut);

                                // we will set timeout at object level
                                CORBA::Object_var newObj = obj->_set_policy_overrides (policyList, CORBA::SET_OVERRIDE);

                                policyList[0]->destroy();
                                return T::_narrow(newObj.in());
                        }
                        catch (CORBA::Exception &cex)
                        {
                                acsQoSErrType::CanNotSetTimeoutExImpl ex(__FILE__, __LINE__, "Timeout::setObjectTimeout");
                                ex.addData("Caused by CORBA exception", cex._name());
                                throw ex;
                        }
                }

                static void init(CORBA::ORB_ptr _orb);

                static bool isInitialized();

                static void done();

        private:

                void set();
         
                unsigned long timeout_m;

                CORBA::PolicyList policyList_m;    // policy list for setting timeout

                CORBA::PolicyCurrent_var policyCurrent_m;

                CORBA::PolicyList previousPolicy_m;    // here we'll store previously set timeout
    
                static CORBA::ORB_var orb_m;
                static bool initialized_m;
};//class Timeout

};//namespace acsQoS 

#endif