Aws::Crt::Io::Socks5ProxyOptions Class Reference

#include <Socks5.h>

Public Member Functions
	Socks5ProxyOptions (const Aws::Crt::String &proxyHost, uint16_t proxyPort, std::shared_ptr< Socks5ProxyNegotiationStrategy > strategy) noexcept
	Socks5ProxyOptions (const Socks5ProxyOptions &rhs) noexcept
	Socks5ProxyOptions (Socks5ProxyOptions &&rhs) noexcept
Socks5ProxyOptions &	operator= (const Socks5ProxyOptions &rhs)
Socks5ProxyOptions &	operator= (Socks5ProxyOptions &&rhs) noexcept
Socks5ProxyOptions &	withTimeout (std::chrono::milliseconds timeout) noexcept
const Aws::Crt::String &	proxyHost () const noexcept
uint16_t	proxyPort () const noexcept
std::shared_ptr< Socks5ProxyNegotiationStrategy >	strategy () const noexcept
std::chrono::milliseconds	timeout () const noexcept

Detailed Description

Configuration options relevant to routing connections through a SOCKS5 proxy.

Constructor & Destructor Documentation

Socks5ProxyOptions() [1/3]

Aws::Crt::Io::Socks5ProxyOptions::Socks5ProxyOptions ( const Aws::Crt::String &  proxyHost, uint16_t  proxyPort, std::shared_ptr< Socks5ProxyNegotiationStrategy >  strategy  )

noexcept

Constructor for a new instance of SOCKS5 proxy configuration options

Parameters

proxyHost	hostname of the SOCKS5 proxy
proxyPort	listening port of the SOCKS5 proxy
strategy	authentication strategy to use

Socks5ProxyOptions() [2/3]

Aws::Crt::Io::Socks5ProxyOptions::Socks5ProxyOptions ( const Socks5ProxyOptions &  rhs )

noexcept

Socks5ProxyOptions() [3/3]

Aws::Crt::Io::Socks5ProxyOptions::Socks5ProxyOptions ( Socks5ProxyOptions &&  rhs )

noexcept

Member Function Documentation

operator=() [1/2]

Socks5ProxyOptions & Aws::Crt::Io::Socks5ProxyOptions::operator=

(

const Socks5ProxyOptions &

rhs

)

operator=() [2/2]

Socks5ProxyOptions & Aws::Crt::Io::Socks5ProxyOptions::operator= ( Socks5ProxyOptions &&  rhs )

noexcept

proxyHost()

const Aws::Crt::String & Aws::Crt::Io::Socks5ProxyOptions::proxyHost ( ) const

inlinenoexcept

Gets the hostname of the SOCKS5 proxy

Returns

the hostname of the SOCKS5 proxy

proxyPort()

uint16_t Aws::Crt::Io::Socks5ProxyOptions::proxyPort ( ) const

inlinenoexcept

Gets the listening port of the SOCKS5 proxy

Returns

the listening port of the SOCKS5 proxy

strategy()

std::shared_ptr< Socks5ProxyNegotiationStrategy > Aws::Crt::Io::Socks5ProxyOptions::strategy ( ) const

inlinenoexcept

Gets the authentication strategy to use when tunneling through the SOCKS5 proxy

Returns

the authentication strategy to use when tunneling through the SOCKS5 proxy

timeout()

std::chrono::milliseconds Aws::Crt::Io::Socks5ProxyOptions::timeout ( ) const

inlinenoexcept

Gets the maximum amount of time to wait for a successful negotiation

Returns

the maximum amount of time to wait for a successful negotiation

withTimeout()

Socks5ProxyOptions & Aws::Crt::Io::Socks5ProxyOptions::withTimeout ( std::chrono::milliseconds  timeout )

noexcept

Sets the maximum amount of time to wait before a SOCKS5 negotiation attempt is considered failed

Parameters

timeout

maximum amount of time to wait for a successful negotiation

Returns

the configuration options instance

---

The documentation for this class was generated from the following files:

• include/aws/crt/io/Socks5.h
• source/io/Socks5.cpp