Rogue Wave web site:  Home Page  |  Main Documentation Page

rwsf::Transport Class Reference
[Transports]

Reference to all transport implementations. Used in generated proxies. More...

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

Inheritance diagram for rwsf::Transport:

List of all members.

Public Types
enum	statusCode { success, failure }
Public Member Functions
	Transport ()
	Transport (TransportImp *imp)
	Transport (const Transport &trans)
virtual	~Transport ()
Transport &	operator= (const Transport &trans)
void	init (const rwsf::Config &initParams)
Protected Member Functions
TransportImp &	body () const

---

Detailed Description

rwsf::Transport is a reference to all transport implementations, i.e. transport objects that derive from rwsf::TransportImp. A transport is a message handler, so this class derives from rwsf::MessageHandler. Generated proxy classes hold a transport reference which is either directly passed in or inferred from a URL. Generated clients contain a member of this type.

The properties on a transport are configured using the two configuration files transports.xml, and client-transports.xml. For more information on these files, and customizing or creating transports, see the transports chapter in the Web Service Development Guide.

Note:

This class uses reference semantics in which an instance of this class is a reference to an implementation class.

---

Member Enumeration Documentation

enum rwsf::Transport::statusCode

Enumeration containing values for statusCode property.

Enumerator:

success	The transport has been successfully initialized and a connection established, as defined by the transport specification. For example, if HTTP returns 200 (HTTP status code for OK), this value is set to success, otherwise failure.
failure	The transport was not successfully initialized or a connection was not established.

---

Constructor & Destructor Documentation

rwsf::Transport::Transport

(

)

Default constructor. Constructs an empty transport handler.

rwsf::Transport::Transport

(

TransportImp *

imp

)

Constructs a new handler bound to a new transport instance, and increments a reference count.

rwsf::Transport::Transport

(

const Transport &

trans

)

Creates a new handle as a reference to trans.

virtual rwsf::Transport::~Transport

(

)

[virtual]

Destructor.

---

Member Function Documentation

TransportImp& rwsf::Transport::body

(

)

const [protected]

Returns the body attached to this handle; otherwise throws an rwsf::ExternalException.

Reimplemented from rwsf::MessageHandler.

void rwsf::Transport::init

(

const rwsf::Config &

initParams

)

Sets the initialization parameters and initializes the transport.

Reimplemented from rwsf::MessageHandler.

Transport& rwsf::Transport::operator=

(

const Transport &

trans

)

Assignment operator.