LLDB mainline
lldb_private::PseudoConsole Class Reference

#include <PseudoConsole.h>

Public Member Functions

 PseudoConsole ()=default
 ~PseudoConsole ()
 PseudoConsole (const PseudoConsole &)=delete
 PseudoConsole (PseudoConsole &&)=delete
PseudoConsoleoperator= (const PseudoConsole &)=delete
PseudoConsoleoperator= (PseudoConsole &&)=delete
llvm::Error OpenPseudoConsole ()
void Close ()
 Close the ConPTY, its read/write handles and invalidate them.
HPCON GetPseudoTerminalHandle ()
 The ConPTY HPCON handle accessor.
HANDLE GetSTDOUTHandle () const
 The STDOUT read HANDLE accessor.
HANDLE GetSTDINHandle () const
 The STDIN write HANDLE accessor.

Protected Attributes

HANDLE m_conpty_handle = ((HANDLE)(long long)-1)
HANDLE m_conpty_output = ((HANDLE)(long long)-1)
HANDLE m_conpty_input = ((HANDLE)(long long)-1)

Detailed Description

Definition at line 21 of file PseudoConsole.h.

Constructor & Destructor Documentation

◆ PseudoConsole() [1/3]

lldb_private::PseudoConsole::PseudoConsole ( )
default

◆ ~PseudoConsole()

PseudoConsole::~PseudoConsole ( )

Definition at line 67 of file PseudoConsole.cpp.

References Close().

◆ PseudoConsole() [2/3]

lldb_private::PseudoConsole::PseudoConsole ( const PseudoConsole & )
delete

References PseudoConsole().

◆ PseudoConsole() [3/3]

lldb_private::PseudoConsole::PseudoConsole ( PseudoConsole && )
delete

References PseudoConsole().

Member Function Documentation

◆ Close()

void PseudoConsole::Close ( )

Close the ConPTY, its read/write handles and invalidate them.

Definition at line 124 of file PseudoConsole.cpp.

References kernel32, m_conpty_handle, m_conpty_input, and m_conpty_output.

Referenced by OpenPseudoConsole(), and ~PseudoConsole().

◆ GetPseudoTerminalHandle()

HPCON lldb_private::PseudoConsole::GetPseudoTerminalHandle ( )
inline

The ConPTY HPCON handle accessor.

This object retains ownership of the HPCON when this accessor is used.

Returns
The ConPTY HPCON handle, or INVALID_HANDLE_VALUE if it is currently invalid.

Definition at line 44 of file PseudoConsole.h.

References m_conpty_handle.

◆ GetSTDINHandle()

HANDLE lldb_private::PseudoConsole::GetSTDINHandle ( ) const
inline

The STDIN write HANDLE accessor.

This object retains ownership of the HANDLE when this accessor is used.

Returns
The STDIN write HANDLE, or INVALID_HANDLE_VALUE if it is currently invalid.

Definition at line 62 of file PseudoConsole.h.

References m_conpty_input.

◆ GetSTDOUTHandle()

HANDLE lldb_private::PseudoConsole::GetSTDOUTHandle ( ) const
inline

The STDOUT read HANDLE accessor.

This object retains ownership of the HANDLE when this accessor is used.

Returns
The STDOUT read HANDLE, or INVALID_HANDLE_VALUE if it is currently invalid.

Definition at line 53 of file PseudoConsole.h.

References m_conpty_output.

◆ OpenPseudoConsole()

llvm::Error PseudoConsole::OpenPseudoConsole ( )

Definition at line 69 of file PseudoConsole.cpp.

References Close(), kernel32, m_conpty_handle, m_conpty_input, and m_conpty_output.

◆ operator=() [1/2]

PseudoConsole & lldb_private::PseudoConsole::operator= ( const PseudoConsole & )
delete

References PseudoConsole().

◆ operator=() [2/2]

PseudoConsole & lldb_private::PseudoConsole::operator= ( PseudoConsole && )
delete

References PseudoConsole().

Member Data Documentation

◆ m_conpty_handle

HANDLE lldb_private::PseudoConsole::m_conpty_handle = ((HANDLE)(long long)-1)
protected

Definition at line 65 of file PseudoConsole.h.

Referenced by Close(), GetPseudoTerminalHandle(), and OpenPseudoConsole().

◆ m_conpty_input

HANDLE lldb_private::PseudoConsole::m_conpty_input = ((HANDLE)(long long)-1)
protected

Definition at line 67 of file PseudoConsole.h.

Referenced by Close(), GetSTDINHandle(), and OpenPseudoConsole().

◆ m_conpty_output

HANDLE lldb_private::PseudoConsole::m_conpty_output = ((HANDLE)(long long)-1)
protected

Definition at line 66 of file PseudoConsole.h.

Referenced by Close(), GetSTDOUTHandle(), and OpenPseudoConsole().


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