llvm::ListeningSocket Class Reference

Manages a passive (i.e., listening) UNIX domain socket. More...

#include "llvm/Support/raw_socket_stream.h"

Public Member Functions
	~ListeningSocket ()
	ListeningSocket (ListeningSocket &&LS)
	ListeningSocket (const ListeningSocket &LS)=delete
ListeningSocket &	operator= (const ListeningSocket &)=delete
void	shutdown ()
	Closes the FD, unlinks the socket file, and writes to PipeFD.
Expected< std::unique_ptr< raw_socket_stream > >	accept (std::chrono::milliseconds Timeout=std::chrono::milliseconds(-1))
	Accepts an incoming connection on the listening socket.

Static Public Member Functions
static Expected< ListeningSocket >	createUnix (StringRef SocketPath, int MaxBacklog=llvm::hardware_concurrency().compute_thread_count())
	Creates a listening socket bound to the specified file system path.

Detailed Description

Manages a passive (i.e., listening) UNIX domain socket.

The ListeningSocket class encapsulates a UNIX domain socket that can listen and accept incoming connections. ListeningSocket is portable and supports Windows builds begining with Insider Build 17063. ListeningSocket is designed for server-side operations, working alongside raw_socket_streams that function as client connections.

Usage example:

std::string Path = "/path/to/socket"
Expected<ListeningSocket> S = ListeningSocket::createUnix(Path);
 
if (S) {
  Expected<std::unique_ptr<raw_socket_stream>> connection = S->accept();
  if (connection) {
    // Use the accepted raw_socket_stream for communication.
  }
}

Definition at line 59 of file raw_socket_stream.h.

Constructor & Destructor Documentation

~ListeningSocket()

ListeningSocket::~ListeningSocket

(

)

Definition at line 274 of file raw_socket_stream.cpp.

References shutdown().

ListeningSocket() [1/2]

ListeningSocket::ListeningSocket

(

ListeningSocket &&

LS

)

Definition at line 100 of file raw_socket_stream.cpp.

ListeningSocket() [2/2]

llvm::ListeningSocket::ListeningSocket ( const ListeningSocket &  LS )

delete

Member Function Documentation

accept()

Expected< std::unique_ptr< raw_socket_stream > > ListeningSocket::accept

(

std::chrono::milliseconds

Timeout = std::chrono::milliseconds(-1)

)

Accepts an incoming connection on the listening socket.

This method can optionally either block until a connection is available or timeout after a specified amount of time has passed. By default the method will block until the socket has recieved a connection.

Parameters

Timeout

An optional timeout duration in milliseconds. Setting Timeout to -1 causes accept to block indefinitely

Definition at line 181 of file raw_socket_stream.cpp.

References accept(), and getLastSocketErrorCode().

Referenced by accept().

createUnix()

Expected< ListeningSocket > ListeningSocket::createUnix ( StringRef  SocketPath, int  MaxBacklog = llvm::hardware_concurrency().compute_thread_count()  )

static

Creates a listening socket bound to the specified file system path.

Handles the socket creation, binding, and immediately starts listening for incoming connections.

Parameters

SocketPath	The file system path where the socket will be created
MaxBacklog	The max number of connections in a socket's backlog

Definition at line 110 of file raw_socket_stream.cpp.

References _, Addr, llvm::consumeError(), llvm::sys::fs::exists(), getLastSocketErrorCode(), getSocketFD(), setSocketAddr(), and llvm::Expected< T >::takeError().

operator=()

ListeningSocket & llvm::ListeningSocket::operator= ( const ListeningSocket &  )

delete

shutdown()

void ListeningSocket::shutdown

(

)

Closes the FD, unlinks the socket file, and writes to PipeFD.

After the construction of the ListeningSocket, shutdown is signal safe if it is called during the lifetime of the object. shutdown can be called concurrently with ListeningSocket::accept as writing to PipeFD will cause a blocking call to ::poll to return.

Once shutdown is called there is no way to reinitialize ListeningSocket.

Definition at line 252 of file raw_socket_stream.cpp.

References llvm::write().

Referenced by ~ListeningSocket().

---

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

• include/llvm/Support/raw_socket_stream.h
• lib/Support/raw_socket_stream.cpp