RWHttpsSecureSocketClient Class Reference
[HTTPS]

Handle class for parent RWHttpClient, providing implementation-specific details for HTTPS clients. More...

#include <rw/https/RWHttpsSecureSocketClient.h>

Inheritance diagram for RWHttpsSecureSocketClient:

List of all members.

Public Member Functions
	RWHttpsSecureSocketClient ()
	RWHttpsSecureSocketClient (const RWHttpsSecureSocketClient &client)
RWHttpsSecureSocketClient &	operator= (const RWHttpsSecureSocketClient &other)
virtual	~RWHttpsSecureSocketClient ()
bool	secureUpgrade ()
Static Public Member Functions
static RWHttpsSecureSocketClient	make (const RWSecureSocketContext &context, RWHttpsConnectionStart s=RW_HTTPS_START_SECURE)
Protected Member Functions
RWHttpsSecureSocketClientImp &	body () const

---

Detailed Description

RWHttpsSecureSocketClient is a derived handle class for RWHttpClient. It provides implementation specific details for HTTPS clients over SSL/TLS enabled sockets.

---

Constructor & Destructor Documentation

RWHttpsSecureSocketClient::RWHttpsSecureSocketClient

(

)

Default constructor. Constructs an invalid handle.

RWHttpsSecureSocketClient::RWHttpsSecureSocketClient

(

const RWHttpsSecureSocketClient &

client

)

Copy constructor.

virtual RWHttpsSecureSocketClient::~RWHttpsSecureSocketClient

(

)

[virtual]

Virtual destructor.

---

Member Function Documentation

RWHttpsSecureSocketClientImp & RWHttpsSecureSocketClient::body

(

void

)

const [inline, protected]

Returns a reference to the body.

Reimplemented from RWHttpClient.

static RWHttpsSecureSocketClient RWHttpsSecureSocketClient::make	(	const RWSecureSocketContext &	context,
		RWHttpsConnectionStart	s = RW_HTTPS_START_SECURE
	)			[static]

Creates a new initialized RWHttpsSecureSocketClient. You must provide an initialized RWSecureSocketContext object. The RWHttpsConnectionStart parameter s determines whether the connection starts in secure mode (the default) or in insecure mode. If the RWHttpsConnectionStart parameter s is RW_HTTPS_START_SECURE, the connection starts in secure mode. If the RWHttpsConnectionStart parameter s is RW_HTTPS_START_INSECURE, the connection starts in insecure mode and waits until the secureUpgrade() member function is called before switching to secure mode.

You can use this function with the HTTP CONNECT method to connect insecurely to a proxy machine and establish a tunnel to a secure machine. After the tunnel is established, use secureUpgrade() to start communicating securely. For more information, see Section 8.2, "Using the HTTP CONNECT Method with the HTTPS Package," in the Secure Communication Module User's Guide.

RWHttpsSecureSocketClient & RWHttpsSecureSocketClient::operator=

(

const RWHttpsSecureSocketClient &

other

)

[inline]

Assignment operator.

bool RWHttpsSecureSocketClient::secureUpgrade

(

)

Begins secure communication on this connection. Returns true on success. If the connection is already secure, simply returns true. Returns false on error.

Call this function only when the RWHttpsSecureSocketClient object starts with an insecure connection by passing RW_HTTPS_START_INSECURE as the second parameter to the static make() function.