#include <ConnectionGenericFileWindows.h>

Inheritance diagram for lldb_private::ConnectionGenericFile:

Public Member Functions
	ConnectionGenericFile ()

	ConnectionGenericFile (lldb::file_t file, bool owns_file)

	~ConnectionGenericFile () override

bool	IsConnected () const override
	Check if the connection is valid.

lldb::ConnectionStatus	Connect (llvm::StringRef s, Status *error_ptr) override
	Connect using the connect string url.

lldb::ConnectionStatus	Disconnect (Status *error_ptr) override
	Disconnect the communications connection if one is currently connected.

size_t	Read (void dst, size_t dst_len, const Timeout< std::micro > &timeout, lldb::ConnectionStatus &status, Status error_ptr) override
	The read function that attempts to read from the connection.

size_t	Write (const void src, size_t src_len, lldb::ConnectionStatus &status, Status error_ptr) override
	The actual write function that attempts to write to the communications protocol.

std::string	GetURI () override
	Returns a URI that describes this connection object.

bool	InterruptRead () override
	Interrupts an ongoing Read() operation.

Public Member Functions inherited from lldb_private::Connection
	Connection ()=default
	Default constructor.

virtual	~Connection ()
	Virtual destructor since this class gets subclassed and handed to a Communication object.

virtual lldb::ConnectionStatus	Connect (llvm::StringRef url, Status *error_ptr)=0
	Connect using the connect string url.

virtual lldb::ConnectionStatus	Disconnect (Status *error_ptr)=0
	Disconnect the communications connection if one is currently connected.

virtual bool	IsConnected () const =0
	Check if the connection is valid.

virtual size_t	Read (void dst, size_t dst_len, const Timeout< std::micro > &timeout, lldb::ConnectionStatus &status, Status error_ptr)=0
	The read function that attempts to read from the connection.

virtual size_t	Write (const void dst, size_t dst_len, lldb::ConnectionStatus &status, Status error_ptr)=0
	The actual write function that attempts to write to the communications protocol.

virtual std::string	GetURI ()=0
	Returns a URI that describes this connection object.

virtual bool	InterruptRead ()=0
	Interrupts an ongoing Read() operation.

virtual lldb::IOObjectSP	GetReadObject ()
	Returns the underlying IOObject used by the Connection.

Protected Types
enum	{ kBytesAvailableEvent , kInterruptEvent }

Protected Attributes
OVERLAPPED	m_overlapped

HANDLE	m_file

HANDLE	m_event_handles [2]

bool	m_owns_file

LARGE_INTEGER	m_file_position

Private Member Functions
void	InitializeEventHandles ()

void	IncrementFilePointer (DWORD amount)

	ConnectionGenericFile (const ConnectionGenericFile &)=delete

const ConnectionGenericFile &	operator= (const ConnectionGenericFile &)=delete

Private Attributes
std::string	m_uri

Detailed Description

Definition at line 20 of file ConnectionGenericFileWindows.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Enumerator
kBytesAvailableEvent
kInterruptEvent

Definition at line 51 of file ConnectionGenericFileWindows.h.

Constructor & Destructor Documentation

◆ ConnectionGenericFile() [1/3]

ConnectionGenericFile::ConnectionGenericFile ( )

Definition at line 53 of file ConnectionGenericFileWindows.cpp.

References InitializeEventHandles(), m_file_position, and m_overlapped.

◆ ConnectionGenericFile() [2/3]

ConnectionGenericFile::ConnectionGenericFile	(	lldb::file_t	file,
		bool	owns_file
	)

Definition at line 60 of file ConnectionGenericFileWindows.cpp.

References InitializeEventHandles(), m_file_position, and m_overlapped.

◆ ~ConnectionGenericFile()

ConnectionGenericFile::~ConnectionGenericFile ( )

override

Definition at line 67 of file ConnectionGenericFileWindows.cpp.

References IsConnected(), kBytesAvailableEvent, kInterruptEvent, m_event_handles, m_file, and m_owns_file.

◆ ConnectionGenericFile() [3/3]

lldb_private::ConnectionGenericFile::ConnectionGenericFile ( const ConnectionGenericFile & )

privatedelete

Member Function Documentation

◆ Connect()

lldb::ConnectionStatus ConnectionGenericFile::Connect	(	llvm::StringRef	url,
		Status *	error_ptr
	)

overridevirtual

Connect using the connect string url.

Parameters

[in]	url	A string that contains all information needed by the subclass to connect to another client.
[out]	error_ptr	A pointer to an error object that should be given an appropriate error value if this method returns false. This value can be NULL if the error value should be ignored.

Returns: True if the connect succeeded, false otherwise. The internal error object should be filled in with an appropriate value based on the result of this function.

See also: Status& Communication::GetError ();

Implements lldb_private::Connection.

Definition at line 92 of file ConnectionGenericFileWindows.cpp.

References lldb_private::Connection, Disconnect(), lldb::eConnectionStatusError, lldb::eConnectionStatusSuccess, lldb::eErrorTypeGeneric, lldb::eErrorTypeWin32, lldb_private::GetLog(), IsConnected(), LLDB_LOGF, m_file, m_owns_file, m_uri, lldb_private::Status::SetError(), and lldb_private::Status::SetErrorStringWithFormat().

◆ Disconnect()

lldb::ConnectionStatus ConnectionGenericFile::Disconnect ( Status * error_ptr )

overridevirtual

Disconnect the communications connection if one is currently connected.

Parameters

[out] error_ptr A pointer to an error object that should be given an appropriate error value if this method returns false. This value can be NULL if the error value should be ignored.

Returns: True if the disconnect succeeded, false otherwise. The internal error object should be filled in with an appropriate value based on the result of this function.

See also: Status& Communication::GetError ();

Implements lldb_private::Connection.

Definition at line 135 of file ConnectionGenericFileWindows.cpp.

References lldb_private::Connection, lldb::eConnectionStatusSuccess, lldb_private::GetLog(), IsConnected(), LLDB_LOGF, m_file, m_file_position, m_overlapped, m_owns_file, and m_uri.

Referenced by Connect().

◆ GetURI()

std::string ConnectionGenericFile::GetURI ( )

overridevirtual

Returns a URI that describes this connection object.

Subclasses may override this function.

Returns: Returns URI or an empty string if disconnecteds

Implements lldb_private::Connection.

Definition at line 305 of file ConnectionGenericFileWindows.cpp.

References m_uri.

◆ IncrementFilePointer()

void ConnectionGenericFile::IncrementFilePointer ( DWORD amount )

private

Definition at line 311 of file ConnectionGenericFileWindows.cpp.

References m_overlapped.

Referenced by Read(), and Write().

◆ InitializeEventHandles()

void ConnectionGenericFile::InitializeEventHandles ( )

private

Definition at line 75 of file ConnectionGenericFileWindows.cpp.

References kBytesAvailableEvent, kInterruptEvent, and m_event_handles.

Referenced by ConnectionGenericFile().

◆ InterruptRead()

bool ConnectionGenericFile::InterruptRead ( )

overridevirtual

Interrupts an ongoing Read() operation.

If there is an ongoing read operation in another thread, this operation return with status == eConnectionStatusInterrupted. Note that if there data waiting to be read and an interrupt request is issued, the Read() function will return the data immediately without processing the interrupt request (which will remain queued for the next Read() operation).

Returns: Returns true is the interrupt request was successful.

Implements lldb_private::Connection.

Definition at line 307 of file ConnectionGenericFileWindows.cpp.

References kInterruptEvent, and m_event_handles.

◆ IsConnected()

bool ConnectionGenericFile::IsConnected ( ) const

overridevirtual

Check if the connection is valid.

Returns: True if this object is currently connected, false otherwise.

Implements lldb_private::Connection.

Definition at line 88 of file ConnectionGenericFileWindows.cpp.

References m_file.

Referenced by Connect(), Disconnect(), Read(), Write(), and ~ConnectionGenericFile().

◆ operator=()

const ConnectionGenericFile & lldb_private::ConnectionGenericFile::operator= ( const ConnectionGenericFile & )

privatedelete

◆ Read()

size_t ConnectionGenericFile::Read	(	void *	dst,
		size_t	dst_len,
		const Timeout< std::micro > &	timeout,
		lldb::ConnectionStatus &	status,
		Status *	error_ptr
	)

overridevirtual

The read function that attempts to read from the connection.

Parameters

[in]	dst	A destination buffer that must be at least dst_len bytes long.
[in]	dst_len	The number of bytes to attempt to read, and also the max number of bytes that can be placed into dst.
[in]	timeout	The number of microseconds to wait for the data.
[out]	status	On return, indicates whether the call was successful or terminated due to some error condition.
[out]	error_ptr	A pointer to an error object that should be given an appropriate error value if this method returns zero. This value can be NULL if the error value should be ignored.

Returns: The number of bytes actually read.

See also: size_t Communication::Read (void *, size_t, uint32_t);

Implements lldb_private::Connection.

Definition at line 163 of file ConnectionGenericFileWindows.cpp.

References lldb_private::Status::Clear(), lldb_private::Connection, lldb::eConnectionStatusEndOfFile, lldb::eConnectionStatusError, lldb::eConnectionStatusInterrupted, lldb::eConnectionStatusNoConnection, lldb::eConnectionStatusSuccess, lldb::eConnectionStatusTimedOut, lldb_private::GetLog(), IncrementFilePointer(), IsConnected(), kBytesAvailableEvent, kInterruptEvent, LLDB_LOGF, m_event_handles, m_file, and m_overlapped.

◆ Write()

size_t ConnectionGenericFile::Write	(	const void *	dst,
		size_t	dst_len,
		lldb::ConnectionStatus &	status,
		Status *	error_ptr
	)

overridevirtual

The actual write function that attempts to write to the communications protocol.

Subclasses must override this function.

Parameters

[in]	dst	A destination buffer that must be at least dst_len bytes long.
[in]	dst_len	The number of bytes to attempt to write, and also the number of bytes are currently available in dst.
[out]	error_ptr	A pointer to an error object that should be given an appropriate error value if this method returns zero. This value can be NULL if the error value should be ignored.