sshpp::Exec Class Reference

#include <exec.hpp>

Public Member Functions
	Exec (Session &session)
Exec &	env (std::string_view name, std::string_view value)
Exec &	pty (bool enable=true, std::string_view term="xterm-256color", PtySize size={})
Exec &	stdin_data (std::string data)
Exec &	timeout (std::chrono::milliseconds t)
Exec &	max_output (std::size_t bytes)
Exec &	merge_stderr (bool v=true)
Exec &	sink (OutputSink s)
Result< ExecResult >	try_run (std::string_view command)
ExecResult	run (std::string_view command)
Result< ExecResult >	try_run (const std::vector< std::string > &argv)
	Builds an argv-style command with correct POSIX shell quoting.

Detailed Description

One-shot remote command execution: opens a channel, requests exec, pumps stdout/stderr without stalling on the interleaving hazard, waits for exit. See docs/design/05 §5.3.

Constructor & Destructor Documentation

Exec()

sshpp::Exec::Exec ( Session &  session )

inlineexplicit

Member Function Documentation

env()

SSHPP_INLINE Exec & sshpp::Exec::env	(	std::string_view	name,
		std::string_view	value
	)

pty()

SSHPP_INLINE Exec & sshpp::Exec::pty	(	bool	enable = true,
		std::string_view	term = "xterm-256color",
		PtySize	size = {}
	)

stdin_data()

SSHPP_INLINE Exec & sshpp::Exec::stdin_data

(

std::string

data

)

timeout()

Exec & sshpp::Exec::timeout ( std::chrono::milliseconds  t )

inline

max_output()

Exec & sshpp::Exec::max_output ( std::size_t  bytes )

inline

merge_stderr()

Exec & sshpp::Exec::merge_stderr ( bool  v = true )

inline

sink()

Exec & sshpp::Exec::sink ( OutputSink  s )

inline

try_run() [1/2]

SSHPP_INLINE Result< ExecResult > sshpp::Exec::try_run

(

std::string_view

command

)

run()

SSHPP_INLINE ExecResult sshpp::Exec::run

(

std::string_view

command

)

try_run() [2/2]

SSHPP_INLINE Result< ExecResult > sshpp::Exec::try_run

(

const std::vector< std::string > &

argv

)

Builds an argv-style command with correct POSIX shell quoting.

---

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

• include/sshpp/exec.hpp
• include/sshpp/detail/exec.ipp