OW_CIMProtocolIFC.hpp

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2001-2004 Vintela, Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
*  - Redistributions of source code must retain the above copyright notice,
*    this list of conditions and the following disclaimer.
*
*  - Redistributions in binary form must reproduce the above copyright notice,
*    this list of conditions and the following disclaimer in the documentation
*    and/or other materials provided with the distribution.
*
*  - Neither the name of Vintela, Inc. nor the names of its
*    contributors may be used to endorse or promote products derived from this
*    software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL Vintela, Inc. OR THE CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*******************************************************************************/

#ifndef OW_CIMPROTOCOL_HPP_INCLUDE_GUARD_
#define OW_CIMPROTOCOL_HPP_INCLUDE_GUARD_
#include "OW_config.h"
#include "OW_Exception.hpp"
#include "OW_CIMFeatures.hpp"
#include "OW_IntrusiveReference.hpp"
#include "OW_IntrusiveCountableBase.hpp"
#include "OW_ClientAuthCBIFC.hpp"
#include "OW_SocketAddress.hpp"
#include "OW_CIMProtocolIStreamIFC.hpp"
#include "OW_Reference.hpp"
#include "OW_IfcsFwd.hpp"
#include <iosfwd>

// The classes and functions defined in this file are not meant for general
// use, they are internal implementation details.  They may change at any time.

namespace OW_NAMESPACE
{

OW_DECLARE_APIEXCEPTION(CIMProtocol, OW_COMMON_API);
class OW_COMMON_API CIMProtocolIFC : public IntrusiveCountableBase
{
public:
   virtual ~CIMProtocolIFC();
   virtual Reference<std::iostream> beginRequest(
         const String& methodName, const String& nameSpace) = 0;

   enum ERequestType
   {
      E_CIM_OPERATION_REQUEST,
      E_CIM_EXPORT_REQUEST,
      E_CIM_BATCH_OPERATION_REQUEST,
      E_CIM_BATCH_EXPORT_REQUEST,
      E_CIM_OPERATION_RESPONSE,
      E_CIM_EXPORT_RESPONSE
   };
   virtual CIMProtocolIStreamIFCRef endRequest(
      const Reference<std::iostream>& request,
      const String& methodName, 
      const String& cimObject, 
      ERequestType requestType, 
      const String& cimProtocolVersion) = 0;
   virtual CIMFeatures getFeatures() = 0;
   
   void setLoginCallBack(const ClientAuthCBIFCRef& loginCB)
      { m_loginCB = loginCB; }
   void setContentType(const String& ct)
      { m_contentType = ct; }
   virtual SocketAddress getLocalAddress() const = 0;
   virtual SocketAddress getPeerAddress()  const = 0;

   virtual void close() = 0;

   static const int INFINITE_TIMEOUT = -1;
   virtual void setReceiveTimeout(int seconds) = 0;
   virtual int getReceiveTimeout() const = 0;
   virtual void setSendTimeout(int seconds) = 0;
   virtual int getSendTimeout() const = 0;
   virtual void setConnectTimeout(int seconds) = 0;
   virtual int getConnectTimeout() const = 0;
   virtual void setTimeouts(int seconds) = 0;

protected:

#ifdef OW_WIN32
#pragma warning (push)
#pragma warning (disable: 4251)
#endif

   ClientAuthCBIFCRef m_loginCB;

#ifdef OW_WIN32
#pragma warning (pop)
#endif

   String m_contentType;
};

} // end namespace OW_NAMESPACE

#endif

---