class Poco::Net::HTTPSessionInstantiator

Overview

A factory for HTTPClientSession objects. More…

#include <HTTPSessionInstantiator.h>

class HTTPSessionInstantiator
{
public:
    // methods

    virtual
    HTTPClientSession*
    createClientSession(const Poco::URI& uri);

    static
    void
    registerInstantiator();

    static
    void
    unregisterInstantiator();

protected:
    // methods

    void
    setProxy(
        const std::string& host,
        Poco::UInt16 port
        );

    const std::string&
    proxyHost() const;

    Poco::UInt16
    proxyPort() const;

    void
    setProxyCredentials(
        const std::string& username,
        const std::string& password
        );

    const std::string&
    proxyUsername() const;

    const std::string&
    proxyPassword() const;
};

Detailed Documentation

A factory for HTTPClientSession objects.

Creates a HTTP session for a given URI. A HTTPSessionInstantiator is not used directly. Instances are registered with a HTTPSessionFactory, and used through it.

Construction

virtual
~HTTPSessionInstantiator()

Destroys the HTTPSessionInstantiator.

Methods

virtual
HTTPClientSession*
createClientSession(const Poco::URI& uri)

Creates a HTTPClientSession for the given URI.

static
void
registerInstantiator()

Registers the instantiator with the global HTTPSessionFactory.

static
void
unregisterInstantiator()

Unregisters the factory with the global HTTPSessionFactory.

void
setProxy(
    const std::string& host,
    Poco::UInt16 port
    )

Sets the proxy host and port.

Called by HTTPSessionFactory.

const std::string&
proxyHost() const

Returns the proxy post.

Poco::UInt16
proxyPort() const

Returns the proxy port.

void
setProxyCredentials(
    const std::string& username,
    const std::string& password
    )

Sets the username and password for proxy authorization (Basic auth only).

const std::string&
proxyUsername() const

Returns the username for proxy authorization.

const std::string&
proxyPassword() const

Returns the password for proxy authorization.