uvco::UnixStreamClient Class Reference

#include <uds.h>

Collaboration diagram for uvco::UnixStreamClient:

Classes
struct	ConnectAwaiter_

Public Member Functions
	UnixStreamClient (const UnixStreamClient &)=delete
	UnixStreamClient (UnixStreamClient &&)=delete
UnixStreamClient &	operator= (const UnixStreamClient &)=delete
UnixStreamClient &	operator= (UnixStreamClient &&)=delete
	~UnixStreamClient ()=default
	UnixStreamClient (const Loop &loop)
Promise< UnixStream >	connect (std::string_view path)
	Connect to a Unix domain socket at the given path.

Private Attributes
const Loop &	loop_

Detailed Description

A client that connects to a Unix domain socket (type SOCK_STREAM).

The connect() method returns a Promise<UnixStream>, which will resolve when the connection is established. The peer address can be obtained using the getPeerName() method on UnixStream.

Constructor & Destructor Documentation

UnixStreamClient() [1/3]

uvco::UnixStreamClient::UnixStreamClient ( const UnixStreamClient & )

delete

UnixStreamClient() [2/3]

uvco::UnixStreamClient::UnixStreamClient ( UnixStreamClient && )

delete

~UnixStreamClient()

uvco::UnixStreamClient::~UnixStreamClient ( )

default

UnixStreamClient() [3/3]

uvco::UnixStreamClient::UnixStreamClient ( const Loop & loop )

inlineexplicit

: loop_{loop} {}

Member Function Documentation

connect()

Promise< UnixStream > uvco::UnixStreamClient::connect

(

std::string_view

path

)

Connect to a Unix domain socket at the given path.

                                                                 {
  ConnectAwaiter_ connect{loop_};
 
#if UV_VERSION_MAJOR == 1 && UV_VERSION_MINOR >= 46
  const uv_status connectStatus =
      uv_pipe_connect2(connect.request_.get(), connect.pipe_.get(), path.data(),
                       path.size(), 0, ConnectAwaiter_::onConnect);
  if (connectStatus != 0) {
    closeHandle(connect.pipe_.release());
    throw UvcoException(connectStatus,
                        "UnixStreamClient::connect() failed immediately");
  }
#else
  uv_pipe_connect(&request_, pipe_.get(), path_.data(), onConnect);
#endif
 
  std::optional<UvcoException> maybeError;
  // Special error handling mechanism to properly close the
  // open but not connected handle.
  try {
    co_return (co_await connect);
  } catch (const UvcoException &e) {
    maybeError = e;
  }
  closeHandle(connect.pipe_.release());
  BOOST_ASSERT(maybeError);
  throw std::move(maybeError.value());
}

operator=() [1/2]

UnixStreamClient & uvco::UnixStreamClient::operator= ( const UnixStreamClient & )

delete

operator=() [2/2]

UnixStreamClient & uvco::UnixStreamClient::operator= ( UnixStreamClient && )

delete

Member Data Documentation

loop_

const Loop& uvco::UnixStreamClient::loop_

private

---

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

• uvco/uds.h
• uvco/uds.cc