sshpp::SessionOptions::Builder Class Reference

#include <session_options.hpp>

Public Member Functions
Builder &	host (std::string v)
Builder &	port (std::uint16_t v)
Builder &	user (std::string v)
Builder &	timeout (std::chrono::microseconds v)
Builder &	identity (std::filesystem::path v)
Result< SessionOptions >	build ()

Detailed Description

Fluent builder over SessionOptions for call-site brevity. Declared after the aggregate itself because it holds one by value (see docs/design/04 §4.2).

Member Function Documentation

host()

Builder & sshpp::SessionOptions::Builder::host ( std::string  v )

inline

port()

Builder & sshpp::SessionOptions::Builder::port ( std::uint16_t  v )

inline

user()

Builder & sshpp::SessionOptions::Builder::user ( std::string  v )

inline

timeout()

Builder & sshpp::SessionOptions::Builder::timeout ( std::chrono::microseconds  v )

inline

identity()

Builder & sshpp::SessionOptions::Builder::identity ( std::filesystem::path  v )

inline

build()

Result< SessionOptions > sshpp::SessionOptions::Builder::build ( )

inline

---

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

• include/sshpp/session_options.hpp