LLDB mainline
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
lldb_private::Socket Class Referenceabstract

#include <Socket.h>

Inheritance diagram for lldb_private::Socket:
Inheritance graph
[legend]

Classes

struct  HostAndPort
 

Public Types

enum  SocketProtocol { ProtocolTcp , ProtocolUdp , ProtocolUnixDomain , ProtocolUnixAbstract }
 
- Public Types inherited from lldb_private::IOObject
enum  FDType { eFDTypeFile , eFDTypeSocket }
 
typedef int WaitableHandle
 

Public Member Functions

 ~Socket () override
 
virtual Status Connect (llvm::StringRef name)=0
 
virtual Status Listen (llvm::StringRef name, int backlog)=0
 
virtual Status Accept (Socket *&socket)=0
 
int GetOption (int level, int option_name, int &option_value)
 
int SetOption (int level, int option_name, int option_value)
 
NativeSocket GetNativeSocket () const
 
SocketProtocol GetSocketProtocol () const
 
Status Read (void *buf, size_t &num_bytes) override
 
Status Write (const void *buf, size_t &num_bytes) override
 
Status Close () override
 
bool IsValid () const override
 
WaitableHandle GetWaitableHandle () override
 
virtual std::string GetRemoteConnectionURI () const
 
- Public Member Functions inherited from lldb_private::IOObject
 IOObject (FDType type)
 
virtual ~IOObject ()
 
virtual Status Read (void *buf, size_t &num_bytes)=0
 
virtual Status Write (const void *buf, size_t &num_bytes)=0
 
virtual bool IsValid () const =0
 
virtual Status Close ()=0
 
FDType GetFdType () const
 
virtual WaitableHandle GetWaitableHandle ()=0
 

Static Public Member Functions

static llvm::Error Initialize ()
 
static void Terminate ()
 
static std::unique_ptr< Socket > Create (const SocketProtocol protocol, bool child_processes_inherit, Status &error)
 
static llvm::Expected< std::unique_ptr< TCPSocket > > TcpListen (llvm::StringRef host_and_port, bool child_processes_inherit, int backlog=5)
 
static llvm::Expected< std::unique_ptr< Socket > > TcpConnect (llvm::StringRef host_and_port, bool child_processes_inherit)
 
static llvm::Expected< std::unique_ptr< UDPSocket > > UdpConnect (llvm::StringRef host_and_port, bool child_processes_inherit)
 
static llvm::Expected< HostAndPort > DecodeHostAndPort (llvm::StringRef host_and_port)
 

Static Public Attributes

static const NativeSocket kInvalidSocketValue = -1
 
- Static Public Attributes inherited from lldb_private::IOObject
static const WaitableHandle kInvalidHandleValue = -1
 

Protected Member Functions

 Socket (SocketProtocol protocol, bool should_close, bool m_child_process_inherit)
 
virtual size_t Send (const void *buf, const size_t num_bytes)
 

Static Protected Member Functions

static void SetLastError (Status &error)
 
static NativeSocket CreateSocket (const int domain, const int type, const int protocol, bool child_processes_inherit, Status &error)
 
static NativeSocket AcceptSocket (NativeSocket sockfd, struct sockaddr *addr, socklen_t *addrlen, bool child_processes_inherit, Status &error)
 

Protected Attributes

SocketProtocol m_protocol
 
NativeSocket m_socket
 
bool m_child_processes_inherit
 
bool m_should_close_fd
 
- Protected Attributes inherited from lldb_private::IOObject
FDType m_fd_type
 

Detailed Description

Definition at line 41 of file Socket.h.

Member Enumeration Documentation

◆ SocketProtocol

enum lldb_private::Socket::SocketProtocol
Enumerator
ProtocolTcp 
ProtocolUdp 
ProtocolUnixDomain 
ProtocolUnixAbstract 

Definition at line 43 of file Socket.h.

Constructor & Destructor Documentation

◆ ~Socket()

Socket::~Socket ( )
override

Definition at line 80 of file Socket.cpp.

References Close().

◆ Socket()

Socket::Socket ( SocketProtocol  protocol,
bool  should_close,
bool  m_child_process_inherit 
)
protected

Definition at line 73 of file Socket.cpp.

Member Function Documentation

◆ Accept()

virtual Status lldb_private::Socket::Accept ( Socket *&  socket)
pure virtual

Implemented in lldb_private::TCPSocket, lldb_private::UDPSocket, and lldb_private::DomainSocket.

◆ AcceptSocket()

NativeSocket Socket::AcceptSocket ( NativeSocket  sockfd,
struct sockaddr *  addr,
socklen_t *  addrlen,
bool  child_processes_inherit,
Status &  error 
)
staticprotected

Definition at line 338 of file Socket.cpp.

References error(), kInvalidSocketValue, and SetLastError().

Referenced by lldb_private::DomainSocket::Accept().

◆ Close()

Status Socket::Close ( )
overridevirtual

Implements lldb_private::IOObject.

Definition at line 272 of file Socket.cpp.

References lldb_private::Connection, error(), lldb_private::GetLog(), IsValid(), kInvalidSocketValue, LLDB_LOGF, m_should_close_fd, m_socket, and SetLastError().

Referenced by lldb_private::TCPSocket::Connect(), lldb_private::TCPSocket::CreateSocket(), and ~Socket().

◆ Connect()

virtual Status lldb_private::Socket::Connect ( llvm::StringRef  name)
pure virtual

Implemented in lldb_private::TCPSocket, lldb_private::UDPSocket, and lldb_private::DomainSocket.

◆ Create()

std::unique_ptr< Socket > Socket::Create ( const SocketProtocol  protocol,
bool  child_processes_inherit,
Status &  error 
)
static

Definition at line 107 of file Socket.cpp.

References error(), ProtocolTcp, ProtocolUdp, ProtocolUnixAbstract, and ProtocolUnixDomain.

Referenced by lldb_private::ConnectionFileDescriptor::AcceptSocket(), lldb_private::ConnectionFileDescriptor::ConnectSocket(), and TcpConnect().

◆ CreateSocket()

NativeSocket Socket::CreateSocket ( const int  domain,
const int  type,
const int  protocol,
bool  child_processes_inherit,
Status &  error 
)
staticprotected

Definition at line 322 of file Socket.cpp.

References error(), kInvalidSocketValue, and SetLastError().

Referenced by lldb_private::DomainSocket::Connect(), lldb_private::UDPSocket::Connect(), lldb_private::TCPSocket::CreateSocket(), lldb_private::TCPSocket::Listen(), and lldb_private::DomainSocket::Listen().

◆ DecodeHostAndPort()

llvm::Expected< Socket::HostAndPort > Socket::DecodeHostAndPort ( llvm::StringRef  host_and_port)
static

Definition at line 189 of file Socket.cpp.

References lldb_private::Socket::HostAndPort::hostname, and lldb_private::Socket::HostAndPort::port.

Referenced by lldb_private::TCPSocket::Connect(), lldb_private::UDPSocket::Connect(), lldb_private::TCPSocket::Listen(), and lldb_private::process_gdb_remote::LLGSArgToURL().

◆ GetNativeSocket()

NativeSocket lldb_private::Socket::GetNativeSocket ( ) const
inline

Definition at line 90 of file Socket.h.

References m_socket.

Referenced by lldb_private::DomainSocket::Accept(), lldb_private::TCPSocket::Connect(), lldb_private::DomainSocket::Connect(), and lldb_private::DomainSocket::Listen().

◆ GetOption()

int Socket::GetOption ( int  level,
int  option_name,
int &  option_value 
)

Definition at line 295 of file Socket.cpp.

References m_socket.

◆ GetRemoteConnectionURI()

virtual std::string lldb_private::Socket::GetRemoteConnectionURI ( ) const
inlinevirtual

Reimplemented in lldb_private::TCPSocket, lldb_private::UDPSocket, and lldb_private::DomainSocket.

Definition at line 105 of file Socket.h.

Referenced by lldb_private::ConnectionFileDescriptor::InitializeSocket().

◆ GetSocketProtocol()

SocketProtocol lldb_private::Socket::GetSocketProtocol ( ) const
inline

Definition at line 91 of file Socket.h.

References m_protocol.

◆ GetWaitableHandle()

IOObject::WaitableHandle Socket::GetWaitableHandle ( )
overridevirtual

Implements lldb_private::IOObject.

Definition at line 212 of file Socket.cpp.

References m_socket.

◆ Initialize()

llvm::Error Socket::Initialize ( )
static

Definition at line 82 of file Socket.cpp.

Referenced by lldb_private::SystemInitializerCommon::Initialize().

◆ IsValid()

bool lldb_private::Socket::IsValid ( ) const
inlineoverridevirtual

Implements lldb_private::IOObject.

Definition at line 98 of file Socket.h.

References kInvalidSocketValue, and m_socket.

Referenced by Close().

◆ Listen()

virtual Status lldb_private::Socket::Listen ( llvm::StringRef  name,
int  backlog 
)
pure virtual

Implemented in lldb_private::TCPSocket, lldb_private::UDPSocket, and lldb_private::DomainSocket.

◆ Read()

Status Socket::Read ( void *  buf,
size_t &  num_bytes 
)
overridevirtual

Implements lldb_private::IOObject.

Definition at line 217 of file Socket.cpp.

References lldb_private::Communication, error(), lldb_private::GetLog(), IsInterrupted(), LLDB_LOGF, m_socket, and SetLastError().

◆ Send()

size_t Socket::Send ( const void *  buf,
const size_t  num_bytes 
)
protectedvirtual

Reimplemented in lldb_private::UDPSocket.

Definition at line 310 of file Socket.cpp.

References m_socket.

Referenced by Write().

◆ SetLastError()

void Socket::SetLastError ( Status &  error)
staticprotected

Definition at line 314 of file Socket.cpp.

References lldb::eErrorTypeWin32, and error().

Referenced by AcceptSocket(), Close(), lldb_private::DomainSocket::Connect(), CreateSocket(), lldb_private::DomainSocket::Listen(), Read(), and Write().

◆ SetOption()

int Socket::SetOption ( int  level,
int  option_name,
int  option_value 
)

Definition at line 303 of file Socket.cpp.

References m_socket.

Referenced by lldb_private::TCPSocket::SetOptionNoDelay(), and lldb_private::TCPSocket::SetOptionReuseAddress().

◆ TcpConnect()

llvm::Expected< std::unique_ptr< Socket > > Socket::TcpConnect ( llvm::StringRef  host_and_port,
bool  child_processes_inherit 
)
static

Definition at line 149 of file Socket.cpp.

References lldb_private::Connection, Create(), error(), lldb_private::GetLog(), LLDB_LOG, and ProtocolTcp.

◆ TcpListen()

llvm::Expected< std::unique_ptr< TCPSocket > > Socket::TcpListen ( llvm::StringRef  host_and_port,
bool  child_processes_inherit,
int  backlog = 5 
)
static

Definition at line 168 of file Socket.cpp.

References lldb_private::Connection, error(), lldb_private::GetLog(), and LLDB_LOG.

◆ Terminate()

void Socket::Terminate ( )
static

Definition at line 101 of file Socket.cpp.

Referenced by lldb_private::SystemInitializerCommon::Terminate().

◆ UdpConnect()

llvm::Expected< std::unique_ptr< UDPSocket > > Socket::UdpConnect ( llvm::StringRef  host_and_port,
bool  child_processes_inherit 
)
static

Definition at line 184 of file Socket.cpp.

References lldb_private::UDPSocket::Connect().

Referenced by lldb_private::ConnectionFileDescriptor::ConnectUDP().

◆ Write()

Status Socket::Write ( const void *  buf,
size_t &  num_bytes 
)
overridevirtual

Implements lldb_private::IOObject.

Definition at line 244 of file Socket.cpp.

References lldb_private::Communication, error(), lldb_private::GetLog(), IsInterrupted(), LLDB_LOGF, m_socket, Send(), and SetLastError().

Member Data Documentation

◆ kInvalidSocketValue

const NativeSocket Socket::kInvalidSocketValue = -1
static

Definition at line 59 of file Socket.h.

Referenced by lldb_private::TCPSocket::Accept(), AcceptSocket(), Close(), CreateSocket(), lldb_private::TCPSocket::GetLocalIPAddress(), lldb_private::TCPSocket::GetLocalPortNumber(), lldb_private::TCPSocket::GetRemoteConnectionURI(), lldb_private::UDPSocket::GetRemoteConnectionURI(), lldb_private::TCPSocket::GetRemoteIPAddress(), lldb_private::TCPSocket::GetRemotePortNumber(), lldb_private::DomainSocket::GetSocketName(), lldb_private::TCPSocket::IsValid(), and IsValid().

◆ m_child_processes_inherit

bool lldb_private::Socket::m_child_processes_inherit
protected

Definition at line 123 of file Socket.h.

Referenced by lldb_private::TCPSocket::Accept(), lldb_private::DomainSocket::Accept(), lldb_private::DomainSocket::Connect(), lldb_private::TCPSocket::CreateSocket(), lldb_private::TCPSocket::Listen(), and lldb_private::DomainSocket::Listen().

◆ m_protocol

SocketProtocol lldb_private::Socket::m_protocol
protected

Definition at line 121 of file Socket.h.

Referenced by GetSocketProtocol().

◆ m_should_close_fd

bool lldb_private::Socket::m_should_close_fd
protected

Definition at line 124 of file Socket.h.

Referenced by Close().

◆ m_socket

NativeSocket lldb_private::Socket::m_socket
protected

Definition at line 122 of file Socket.h.

Referenced by Close(), lldb_private::DomainSocket::Connect(), lldb_private::TCPSocket::CreateSocket(), lldb_private::DomainSocket::DomainSocket(), lldb_private::TCPSocket::GetLocalIPAddress(), lldb_private::TCPSocket::GetLocalPortNumber(), GetNativeSocket(), GetOption(), lldb_private::TCPSocket::GetRemoteConnectionURI(), lldb_private::UDPSocket::GetRemoteConnectionURI(), lldb_private::TCPSocket::GetRemoteIPAddress(), lldb_private::TCPSocket::GetRemotePortNumber(), lldb_private::DomainSocket::GetSocketName(), GetWaitableHandle(), lldb_private::TCPSocket::IsValid(), IsValid(), lldb_private::DomainSocket::Listen(), Read(), Send(), lldb_private::UDPSocket::Send(), SetOption(), lldb_private::TCPSocket::TCPSocket(), lldb_private::UDPSocket::UDPSocket(), and Write().

The documentation for this class was generated from the following files:
Generated on Wed Apr 24 2024 11:20:44 for LLDB by doxygen 1.9.6