NCBI C++ ToolKit
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
CSoapHttpClient Class Reference

Search Toolkit Book for CSoapHttpClient

#include <serial/soap/soap_client.hpp>

+ Inheritance diagram for CSoapHttpClient:
+ Collaboration diagram for CSoapHttpClient:

Public Member Functions

 CSoapHttpClient (const string &server_url, const string &namespace_name)
 
 ~CSoapHttpClient (void)
 
void SetServerUrl (const string &server_url)
 Set SOAP server URL. More...
 
const stringGetServerUrl (void) const
 Get SOAP server URL. More...
 
void SetDefaultNamespaceName (const string &namespace_name)
 Set default namespace name. More...
 
const stringGetDefaultNamespaceName (void) const
 Get default namespace name. More...
 
void SetUserHeader (const string &user_header)
 Set additional HTTP user header to use in Invoke calls. More...
 
const stringGetUserHeader (void) const
 Get additional HTTP user header. More...
 
void RegisterObjectType (TTypeInfoGetter type_getter)
 Register incoming object type. More...
 
void Invoke (CSoapMessage &response, const CSoapMessage &request, CConstRef< CSoapFault > *fault=0, const string &soap_action=kEmptyStr) const
 Invoke SOAP server procedure synchronously: send 'request' and receive 'response'. More...
 
- Public Member Functions inherited from CObject
 CObject (void)
 Constructor. More...
 
 CObject (const CObject &src)
 Copy constructor. More...
 
virtual ~CObject (void)
 Destructor. More...
 
CObjectoperator= (const CObject &src) THROWS_NONE
 Assignment operator. More...
 
bool CanBeDeleted (void) const THROWS_NONE
 Check if object can be deleted. More...
 
bool IsAllocatedInPool (void) const THROWS_NONE
 Check if object is allocated in memory pool (not system heap) More...
 
bool Referenced (void) const THROWS_NONE
 Check if object is referenced. More...
 
bool ReferencedOnlyOnce (void) const THROWS_NONE
 Check if object is referenced only once. More...
 
void AddReference (void) const
 Add reference to object. More...
 
void RemoveReference (void) const
 Remove reference to object. More...
 
void ReleaseReference (void) const
 Remove reference without deleting object. More...
 
virtual void DoNotDeleteThisObject (void)
 Mark this object as not allocated in heap – do not delete this object. More...
 
virtual void DoDeleteThisObject (void)
 Mark this object as allocated in heap – object can be deleted. More...
 
void * operator new (size_t size)
 Define new operator for memory allocation. More...
 
void * operator new[] (size_t size)
 Define new[] operator for 'array' memory allocation. More...
 
void operator delete (void *ptr)
 Define delete operator for memory deallocation. More...
 
void operator delete[] (void *ptr)
 Define delete[] operator for memory deallocation. More...
 
void * operator new (size_t size, void *place)
 Define new operator. More...
 
void operator delete (void *ptr, void *place)
 Define delete operator. More...
 
void * operator new (size_t size, CObjectMemoryPool *place)
 Define new operator using memory pool. More...
 
void operator delete (void *ptr, CObjectMemoryPool *place)
 Define delete operator. More...
 
virtual void DebugDump (CDebugDumpContext ddc, unsigned int depth) const
 Define method for dumping debug information. More...
 
- Public Member Functions inherited from CDebugDumpable
 CDebugDumpable (void)
 
virtual ~CDebugDumpable (void)
 
void DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const
 
void DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const
 
void DumpToConsole (void) const
 

Protected Member Functions

void SetOmitScopePrefixes (bool bOmit)
 
bool GetOmitScopePrefixes () const
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Private Attributes

string m_ServerUrl
 
string m_DefNamespace
 
string m_UserHeader
 
vector< TTypeInfoGetterm_Types
 
bool m_OmitScopePrefixes
 

Additional Inherited Members

- Public Types inherited from CObject
enum  EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern }
 Control filling of newly allocated memory. More...
 
typedef CObjectCounterLocker TLockerType
 Default locker type for CRef. More...
 
typedef atomic< Uint8TCounter
 Counter type is CAtomiCounter. More...
 
typedef Uint8 TCount
 Alias for value type of counter. More...
 
- Static Public Member Functions inherited from CObject
static NCBI_XNCBI_EXPORT void ThrowNullPointerException (void)
 Define method to throw null pointer exception. More...
 
static NCBI_XNCBI_EXPORT void ThrowNullPointerException (const type_info &type)
 
static EAllocFillMode GetAllocFillMode (void)
 
static void SetAllocFillMode (EAllocFillMode mode)
 
static void SetAllocFillMode (const string &value)
 Set mode from configuration parameter value. More...
 
- Static Public Member Functions inherited from CDebugDumpable
static void EnableDebugDump (bool on)
 
- Static Public Attributes inherited from CObject
static const TCount eCounterBitsCanBeDeleted = 1 << 0
 Define possible object states. More...
 
static const TCount eCounterBitsInPlainHeap = 1 << 1
 Heap signature was found. More...
 
static const TCount eCounterBitsPlaceMask
 Mask for 'in heap' state flags. More...
 
static const int eCounterStep = 1 << 2
 Skip over the "in heap" bits. More...
 
static const TCount eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2)
 Minimal value for valid objects (reference counter is zero) Must be a single bit value. More...
 
static const TCount eCounterStateMask
 Valid object, and object in heap. More...
 

Detailed Description

Definition at line 42 of file soap_client.hpp.

Constructor & Destructor Documentation

◆ CSoapHttpClient()

CSoapHttpClient::CSoapHttpClient ( const string server_url,
const string namespace_name 
)

Definition at line 44 of file soap_client.cpp.

◆ ~CSoapHttpClient()

CSoapHttpClient::~CSoapHttpClient ( void  )

Definition at line 51 of file soap_client.cpp.

Member Function Documentation

◆ GetDefaultNamespaceName()

const string & CSoapHttpClient::GetDefaultNamespaceName ( void  ) const

Get default namespace name.

Definition at line 67 of file soap_client.cpp.

References m_DefNamespace.

Referenced by CSampleSoapClient::GetDescription(), and CSampleSoapClient::GetVersion().

◆ GetOmitScopePrefixes()

bool CSoapHttpClient::GetOmitScopePrefixes ( ) const
inlineprotected

Definition at line 102 of file soap_client.hpp.

References m_OmitScopePrefixes.

◆ GetServerUrl()

const string & CSoapHttpClient::GetServerUrl ( void  ) const

Get SOAP server URL.

Definition at line 59 of file soap_client.cpp.

References m_ServerUrl.

◆ GetUserHeader()

const string & CSoapHttpClient::GetUserHeader ( void  ) const

Get additional HTTP user header.

Definition at line 76 of file soap_client.cpp.

References m_UserHeader.

◆ Invoke()

void CSoapHttpClient::Invoke ( CSoapMessage response,
const CSoapMessage request,
CConstRef< CSoapFault > *  fault = 0,
const string soap_action = kEmptyStr 
) const

Invoke SOAP server procedure synchronously: send 'request' and receive 'response'.

Parameters
responseServer response
requestClient request
faultOn failure, Fault message returned by the server.
soap_actionHTTP SOAPAction header

Definition at line 98 of file soap_client.cpp.

References CONN_CONTENT_TYPE_LEN, eENCOD_None, eMIME_T_Text, eMIME_Xml, eSerial_Xml, eSerialSkipUnknown_Yes, eSerialVerifyData_No, m_OmitScopePrefixes, m_ServerUrl, m_Types, m_UserHeader, MIME_ComposeContentTypeEx(), CObjectIStream::Open(), CObjectOStream::Open(), CSoapMessage::RegisterObjectType(), CSoapMessage::Reset(), and x_ParseHttpHeader().

Referenced by CSampleSoapClient::DoMath(), CSampleSoapClient::GetDescription(), and CSampleSoapClient::GetVersion().

◆ RegisterObjectType()

void CSoapHttpClient::RegisterObjectType ( TTypeInfoGetter  type_getter)

Register incoming object type.

This is needed so that the SOAP message parser could recognize these objects in incoming data and parse them correctly

Parameters
type_getterFunction that returns TTypeInfo information

Definition at line 81 of file soap_client.cpp.

References m_Types.

Referenced by CSampleSoapClient::CSampleSoapClient().

◆ SetDefaultNamespaceName()

void CSoapHttpClient::SetDefaultNamespaceName ( const string namespace_name)

Set default namespace name.

NOTE: Client does not use this name directly, it only stores it.

Definition at line 63 of file soap_client.cpp.

References m_DefNamespace.

◆ SetOmitScopePrefixes()

void CSoapHttpClient::SetOmitScopePrefixes ( bool  bOmit)
protected

Definition at line 147 of file soap_client.cpp.

References m_OmitScopePrefixes.

◆ SetServerUrl()

void CSoapHttpClient::SetServerUrl ( const string server_url)

Set SOAP server URL.

Definition at line 55 of file soap_client.cpp.

References m_ServerUrl.

◆ SetUserHeader()

void CSoapHttpClient::SetUserHeader ( const string user_header)

Set additional HTTP user header to use in Invoke calls.

When communicating with SOAP server, the client adds this text AS IS into HTTP header.

Definition at line 72 of file soap_client.cpp.

References m_UserHeader.

Member Data Documentation

◆ m_DefNamespace

string CSoapHttpClient::m_DefNamespace
private

Definition at line 109 of file soap_client.hpp.

Referenced by GetDefaultNamespaceName(), and SetDefaultNamespaceName().

◆ m_OmitScopePrefixes

bool CSoapHttpClient::m_OmitScopePrefixes
private

Definition at line 112 of file soap_client.hpp.

Referenced by GetOmitScopePrefixes(), Invoke(), and SetOmitScopePrefixes().

◆ m_ServerUrl

string CSoapHttpClient::m_ServerUrl
private

Definition at line 108 of file soap_client.hpp.

Referenced by GetServerUrl(), Invoke(), and SetServerUrl().

◆ m_Types

vector< TTypeInfoGetter > CSoapHttpClient::m_Types
private

Definition at line 111 of file soap_client.hpp.

Referenced by Invoke(), and RegisterObjectType().

◆ m_UserHeader

string CSoapHttpClient::m_UserHeader
private

Definition at line 110 of file soap_client.hpp.

Referenced by GetUserHeader(), Invoke(), and SetUserHeader().


The documentation for this class was generated from the following files:
Modified on Thu Jul 18 16:08:09 2024 by modify_doxy.py rev. 669887