HydraExpress™ C++ API Reference Guide

Product Documentation:
   HydraExpress C++
Documentation Home
List of all members | Public Member Functions | Protected Member Functions
rwsf::HttpTransport Class Reference

Receives and parses HTTP messages. Not intended for direct use. More...

#include <rwsf/webservice/transport/HttpTransport.h>

Inheritance diagram for rwsf::HttpTransport:
rwsf::TransportImp rwsf::MessageHandlerImp rwsf::HttpsTransport

Public Member Functions

virtual TransportImpclone () const
 
virtual void doInvoke (rwsf::CallInfo &callInfo)
 
virtual bool isConnected () const
 
- Public Member Functions inherited from rwsf::TransportImp
 TransportImp ()
 
virtual ~TransportImp ()
 
void invoke (rwsf::CallInfo &callInfo)
 
void log (const std::string &message, rwsf::CallInfo::LogLevel l=rwsf::CallInfo::Info)
 
void log (rwsf::CallInfo &callInfo, rwsf::CallInfo::LogLevel loglevel=rwsf::CallInfo::Info)
 
- Public Member Functions inherited from rwsf::MessageHandlerImp
 MessageHandlerImp ()
 
virtual ~MessageHandlerImp ()
 
virtual void destroy ()
 
virtual void init (const rwsf::Config &initParams)
 

Protected Member Functions

virtual void doConnect ()
 
virtual void doDisconnect ()
 
virtual void doInit (const rwsf::Config &initParams)
 
virtual void doSetProperty (const std::string &key, const std::string &value)
 

Additional Inherited Members

- Protected Attributes inherited from rwsf::TransportImp
rwsf::Config initParams_
 

Detailed Description

This class receives and parses HTTP messages. It is responsible for extracting metadata and the message payload, and passing the information to the web service processor.

Note
This class is not intended to be used directly in your applications. Rather, configure the HTTP transport in the transport configuration file, generated for each service in the generated project directory's conf directory, either the client transports file, client-transports.xml or the server transports file transports.xml. For more information, see the transports chapter in the Web Services Development Guide.

Member Function Documentation

virtual TransportImp* rwsf::HttpTransport::clone ( ) const
virtual

Derived classes should return a new instance of self. (for example, new rwsf::HttpTransport(*this);).

Implements rwsf::TransportImp.

Reimplemented in rwsf::HttpsTransport.

virtual void rwsf::HttpTransport::doConnect ( )
protectedvirtual

Derived classes must implement this method to verify that there is a connection. If there is no connection, this method creates one.

Implements rwsf::TransportImp.

Reimplemented in rwsf::HttpsTransport.

virtual void rwsf::HttpTransport::doDisconnect ( )
protectedvirtual

Derived classes must implement this method to disconnect a server connection.

Implements rwsf::TransportImp.

virtual void rwsf::HttpTransport::doInit ( const rwsf::Config initParams)
protectedvirtual

Derived classes can implement this method to be notified when the initialization parameters, initParams, are set for this TransportImp.

Note
If the transport cannot be initialized, an rwsf::Exception should be thrown. On the client side, exceptions are propagated out to your application code; on the server side, they are logged.

Reimplemented from rwsf::TransportImp.

virtual void rwsf::HttpTransport::doInvoke ( rwsf::CallInfo callInfo)
virtual

Derived classes must implement this method to define the transport handler's behavior.

Implements rwsf::TransportImp.

virtual void rwsf::HttpTransport::doSetProperty ( const std::string &  key,
const std::string &  value 
)
protectedvirtual

Derived classes can implement this method to be notified when properties are set on this TransportImp object. The key and value are the most recent property values set.

Reimplemented from rwsf::TransportImp.

virtual bool rwsf::HttpTransport::isConnected ( ) const
virtual

Derived classes must implement this method to indicate whether the transport is connected or not. Returns true if connected, false otherwise.

Implements rwsf::TransportImp.

Reimplemented in rwsf::HttpsTransport.

Copyright © 2019 Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is registered trademark of Rogue Wave Software, Inc. in the United States and other countries, and HydraExpress is a trademark of Rogue Wave Software. All other trademarks are the property of their respective owners.
Provide feedback to Rogue Wave about its documentation.