OW_NAMESPACE::CIMProtocolIFC Class Reference

#include <OW_CIMProtocolIFC.hpp>

Inheritance diagram for OW_NAMESPACE::CIMProtocolIFC:

[legend]Collaboration diagram for OW_NAMESPACE::CIMProtocolIFC:

[legend]List of all members.

Public Types
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 }
	These request types correspond to the various types of operations identified in the CIM Operations Over HTTP 1.1 Sec. More...
Public Member Functions
virtual	~CIMProtocolIFC ()
virtual Reference< std::iostream >	beginRequest (const String &methodName, const String &nameSpace)=0
virtual CIMProtocolIStreamIFCRef	endRequest (const Reference< std::iostream > &request, const String &methodName, const String &cimObject, ERequestType requestType, const String &cimProtocolVersion)=0
	Establishes a connection (if not already connected) to the CIMOM and sends a request.
virtual CIMFeatures	getFeatures ()=0
	Get the supported features of a CIMOM.
void	setLoginCallBack (const ClientAuthCBIFCRef &loginCB)
	Assigns a login callback object.
void	setContentType (const String &ct)
virtual SocketAddress	getLocalAddress () const =0
	Gets the address of the local machine.
virtual SocketAddress	getPeerAddress () const =0
	Gets the address of the peer connection.
virtual void	close ()=0
	Close the connetion to the CIMOM.
virtual void	setReceiveTimeout (int seconds)=0
	Set the receive timeout on the socket.
virtual int	getReceiveTimeout () const =0
	Get the receive timeout.
virtual void	setSendTimeout (int seconds)=0
	Set the send timeout on the socket.
virtual int	getSendTimeout () const =0
	Get the send timeout.
virtual void	setConnectTimeout (int seconds)=0
	Set the connect timeout on the socket.
virtual int	getConnectTimeout () const =0
	Get the connect timeout.
virtual void	setTimeouts (int seconds)=0
	Set all timeouts (send, receive, connect).
Static Public Attributes
static const int	INFINITE_TIMEOUT = -1
Protected Attributes
ClientAuthCBIFCRef	m_loginCB
String	m_contentType

---

Detailed Description

Definition at line 57 of file OW_CIMProtocolIFC.hpp.

---

Member Enumeration Documentation

enum OW_NAMESPACE::CIMProtocolIFC::ERequestType

These request types correspond to the various types of operations identified in the CIM Operations Over HTTP 1.1 Sec. 3 Enumerator: 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  Definition at line 68 of file OW_CIMProtocolIFC.hpp.

---

Constructor & Destructor Documentation

OW_NAMESPACE::CIMProtocolIFC::~CIMProtocolIFC (   )  [virtual]

Definition at line 43 of file OW_CIMProtocolIFC.cpp.

---

Member Function Documentation

virtual Reference<std::iostream> OW_NAMESPACE::CIMProtocolIFC::beginRequest (  const String &  methodName, const String &  nameSpace )  [pure virtual]

Implemented in OW_NAMESPACE::HTTPClient.

virtual void OW_NAMESPACE::CIMProtocolIFC::close (   )  [pure virtual]

Close the connetion to the CIMOM. This will free resources used for the client session. Implemented in OW_NAMESPACE::HTTPClient.

virtual CIMProtocolIStreamIFCRef OW_NAMESPACE::CIMProtocolIFC::endRequest (  const Reference< std::iostream > &  request, const String &  methodName, const String &  cimObject, ERequestType  requestType, const String &  cimProtocolVersion )  [pure virtual]

Establishes a connection (if not already connected) to the CIMOM and sends a request. An istream& is returned containing the response from the CIMOM, after protocol processing is done. Parameters: request  An istream& containing the request to be send to the CIMOM. methodName  The CIM method that corresponds to the request. the CIM object the request applies to. If this is an intrinsic method, it must be a namespace. If an extrinsic method is being invoked, it must be a class or instance path in ObjectPath format. requestType  The type of request, currently must be one of E_CIM_OPERATION_REQUEST, or E_CIM_EXPORT_REQUEST cimProtocolVersion  The version of the CIM Protocol in use Returns: a CIMProtocolIstream (istream) reference containing the response from the server. Exceptions: HTTPException  SocketException

virtual int OW_NAMESPACE::CIMProtocolIFC::getConnectTimeout (   )  const [pure virtual]

Get the connect timeout. Returns: The number of seconds of the connect timeout Implemented in OW_NAMESPACE::HTTPClient.

virtual CIMFeatures OW_NAMESPACE::CIMProtocolIFC::getFeatures (   )  [pure virtual]

Get the supported features of a CIMOM. Returns: a CIMFeatures object listing the features of the CIMOM. Implemented in OW_NAMESPACE::HTTPClient.

virtual SocketAddress OW_NAMESPACE::CIMProtocolIFC::getLocalAddress (   )  const [pure virtual]

Gets the address of the local machine. Returns: An SocketAddress corresponding to the local machine. Implemented in OW_NAMESPACE::HTTPClient.

virtual SocketAddress OW_NAMESPACE::CIMProtocolIFC::getPeerAddress (   )  const [pure virtual]

Gets the address of the peer connection. Returns: An SocketAddress corresponding to the peer connection Implemented in OW_NAMESPACE::HTTPClient.

virtual int OW_NAMESPACE::CIMProtocolIFC::getReceiveTimeout (   )  const [pure virtual]

Get the receive timeout. Returns: The number of seconds of the receive timeout Implemented in OW_NAMESPACE::HTTPClient.

virtual int OW_NAMESPACE::CIMProtocolIFC::getSendTimeout (   )  const [pure virtual]

Get the send timeout. Returns: The number of seconds of the send timeout Implemented in OW_NAMESPACE::HTTPClient.

virtual void OW_NAMESPACE::CIMProtocolIFC::setConnectTimeout (  int  seconds  )  [pure virtual]

Set the connect timeout on the socket. Parameters: seconds  the number of seconds for the connect timeout Implemented in OW_NAMESPACE::HTTPClient.

void OW_NAMESPACE::CIMProtocolIFC::setContentType (  const String &  ct  )  [inline]

Definition at line 116 of file OW_CIMProtocolIFC.hpp.

void OW_NAMESPACE::CIMProtocolIFC::setLoginCallBack (  const ClientAuthCBIFCRef &  loginCB  )  [inline]

Assigns a login callback object. Parameters: loginCB  A Reference to a ClientAuthCB object containing the callback method. Definition at line 114 of file OW_CIMProtocolIFC.hpp.

virtual void OW_NAMESPACE::CIMProtocolIFC::setReceiveTimeout (  int  seconds  )  [pure virtual]

Set the receive timeout on the socket. Parameters: seconds  the number of seconds for the receive timeout Implemented in OW_NAMESPACE::HTTPClient.

virtual void OW_NAMESPACE::CIMProtocolIFC::setSendTimeout (  int  seconds  )  [pure virtual]

Set the send timeout on the socket. Parameters: seconds  the number of seconds for the send timeout Implemented in OW_NAMESPACE::HTTPClient.

virtual void OW_NAMESPACE::CIMProtocolIFC::setTimeouts (  int  seconds  )  [pure virtual]

Set all timeouts (send, receive, connect). Parameters: seconds  the number of seconds for the timeouts Implemented in OW_NAMESPACE::HTTPClient.

---

Member Data Documentation

const int OW_NAMESPACE::CIMProtocolIFC::INFINITE_TIMEOUT = -1 [static]

Reimplemented in OW_NAMESPACE::HTTPClient. Definition at line 135 of file OW_CIMProtocolIFC.hpp.

String OW_NAMESPACE::CIMProtocolIFC::m_contentType [protected]

Definition at line 185 of file OW_CIMProtocolIFC.hpp.

ClientAuthCBIFCRef OW_NAMESPACE::CIMProtocolIFC::m_loginCB [protected]

Definition at line 179 of file OW_CIMProtocolIFC.hpp. Referenced by OW_NAMESPACE::HTTPClient::getCredentialsIfNecessary().

---

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

• OW_CIMProtocolIFC.hpp
• OW_CIMProtocolIFC.cpp

---