LLDB  mainline
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
lldb::SBAttachInfo Class Reference

#include <SBAttachInfo.h>

Collaboration diagram for lldb::SBAttachInfo:
Collaboration graph
[legend]

Public Member Functions

 SBAttachInfo ()
 
 SBAttachInfo (lldb::pid_t pid)
 
 SBAttachInfo (const char *path, bool wait_for)
 Attach to a process by name. More...
 
 SBAttachInfo (const char *path, bool wait_for, bool async)
 Attach to a process by name. More...
 
 SBAttachInfo (const SBAttachInfo &rhs)
 
 ~SBAttachInfo ()
 
SBAttachInfooperator= (const SBAttachInfo &rhs)
 
lldb::pid_t GetProcessID ()
 
void SetProcessID (lldb::pid_t pid)
 
void SetExecutable (const char *path)
 
void SetExecutable (lldb::SBFileSpec exe_file)
 
bool GetWaitForLaunch ()
 
void SetWaitForLaunch (bool b)
 Set attach by process name settings. More...
 
void SetWaitForLaunch (bool b, bool async)
 Set attach by process name settings. More...
 
bool GetIgnoreExisting ()
 
void SetIgnoreExisting (bool b)
 
uint32_t GetResumeCount ()
 
void SetResumeCount (uint32_t c)
 
const char * GetProcessPluginName ()
 
void SetProcessPluginName (const char *plugin_name)
 
uint32_t GetUserID ()
 
uint32_t GetGroupID ()
 
bool UserIDIsValid ()
 
bool GroupIDIsValid ()
 
void SetUserID (uint32_t uid)
 
void SetGroupID (uint32_t gid)
 
uint32_t GetEffectiveUserID ()
 
uint32_t GetEffectiveGroupID ()
 
bool EffectiveUserIDIsValid ()
 
bool EffectiveGroupIDIsValid ()
 
void SetEffectiveUserID (uint32_t uid)
 
void SetEffectiveGroupID (uint32_t gid)
 
lldb::pid_t GetParentProcessID ()
 
void SetParentProcessID (lldb::pid_t pid)
 
bool ParentProcessIDIsValid ()
 
SBListener GetListener ()
 Get the listener that will be used to receive process events. More...
 
void SetListener (SBListener &listener)
 Set the listener that will be used to receive process events. More...
 

Protected Member Functions

lldb_private::ProcessAttachInforef ()
 

Protected Attributes

ProcessAttachInfoSP m_opaque_sp
 

Friends

class SBTarget
 

Detailed Description

Definition at line 18 of file SBAttachInfo.h.

Constructor & Destructor Documentation

◆ SBAttachInfo() [1/5]

SBAttachInfo::SBAttachInfo ( )

Definition at line 19 of file SBAttachInfo.cpp.

References LLDB_RECORD_CONSTRUCTOR_NO_ARGS.

◆ SBAttachInfo() [2/5]

SBAttachInfo::SBAttachInfo ( lldb::pid_t  pid)

Definition at line 23 of file SBAttachInfo.cpp.

References LLDB_RECORD_CONSTRUCTOR, and m_opaque_sp.

◆ SBAttachInfo() [3/5]

SBAttachInfo::SBAttachInfo ( const char *  path,
bool  wait_for 
)

Attach to a process by name.

This function implies that a future call to SBTarget::Attach(...) will be synchronous.

Parameters
[in]pathA full or partial name for the process to attach to.
[in]wait_forIf false, attach to an existing process whose name matches. If true, then wait for the next process whose name matches.

Definition at line 30 of file SBAttachInfo.cpp.

References LLDB_RECORD_CONSTRUCTOR, and m_opaque_sp.

◆ SBAttachInfo() [4/5]

SBAttachInfo::SBAttachInfo ( const char *  path,
bool  wait_for,
bool  async 
)

Attach to a process by name.

Future calls to SBTarget::Attach(...) will be synchronous or asynchronous depending on the async argument.

Parameters
[in]pathA full or partial name for the process to attach to.
[in]wait_forIf false, attach to an existing process whose name matches. If true, then wait for the next process whose name matches.
[in]asyncIf false, then the SBTarget::Attach(...) call will be a synchronous call with no way to cancel the attach in progress. If true, then the SBTarget::Attach(...) function will return immediately and clients are expected to wait for a process eStateStopped event if a suitable process is eventually found. If the client wants to cancel the event, SBProcess::Stop() can be called and an eStateExited process event will be delivered.

Definition at line 39 of file SBAttachInfo.cpp.

References LLDB_RECORD_CONSTRUCTOR, and m_opaque_sp.

◆ SBAttachInfo() [5/5]

SBAttachInfo::SBAttachInfo ( const SBAttachInfo rhs)

Definition at line 50 of file SBAttachInfo.cpp.

References lldb_private::clone(), LLDB_RECORD_CONSTRUCTOR, and m_opaque_sp.

◆ ~SBAttachInfo()

SBAttachInfo::~SBAttachInfo ( )
default

Member Function Documentation

◆ EffectiveGroupIDIsValid()

bool SBAttachInfo::EffectiveGroupIDIsValid ( )

Definition at line 212 of file SBAttachInfo.cpp.

References LLDB_RECORD_METHOD_NO_ARGS, and m_opaque_sp.

◆ EffectiveUserIDIsValid()

bool SBAttachInfo::EffectiveUserIDIsValid ( )

Definition at line 206 of file SBAttachInfo.cpp.

References LLDB_RECORD_METHOD_NO_ARGS, and m_opaque_sp.

◆ GetEffectiveGroupID()

uint32_t SBAttachInfo::GetEffectiveGroupID ( )

Definition at line 200 of file SBAttachInfo.cpp.

References LLDB_RECORD_METHOD_NO_ARGS, and m_opaque_sp.

◆ GetEffectiveUserID()

uint32_t SBAttachInfo::GetEffectiveUserID ( )

Definition at line 194 of file SBAttachInfo.cpp.

References LLDB_RECORD_METHOD_NO_ARGS, and m_opaque_sp.

◆ GetGroupID()

uint32_t SBAttachInfo::GetGroupID ( )

Definition at line 164 of file SBAttachInfo.cpp.

References LLDB_RECORD_METHOD_NO_ARGS, and m_opaque_sp.

◆ GetIgnoreExisting()

bool SBAttachInfo::GetIgnoreExisting ( )

Definition at line 146 of file SBAttachInfo.cpp.

References LLDB_RECORD_METHOD_NO_ARGS, and m_opaque_sp.

◆ GetListener()

SBListener SBAttachInfo::GetListener ( )

Get the listener that will be used to receive process events.

If no listener has been set via a call to SBAttachInfo::SetListener(), then an invalid SBListener will be returned (SBListener::IsValid() will return false). If a listener has been set, then the valid listener object will be returned.

Definition at line 249 of file SBAttachInfo.cpp.

References LLDB_RECORD_METHOD_NO_ARGS, LLDB_RECORD_RESULT, m_opaque_sp, and lldb::SBListener.

◆ GetParentProcessID()

lldb::pid_t SBAttachInfo::GetParentProcessID ( )

Definition at line 230 of file SBAttachInfo.cpp.

References LLDB_RECORD_METHOD_NO_ARGS, and m_opaque_sp.

◆ GetProcessID()

lldb::pid_t SBAttachInfo::GetProcessID ( )

Definition at line 70 of file SBAttachInfo.cpp.

References LLDB_RECORD_METHOD_NO_ARGS, and m_opaque_sp.

◆ GetProcessPluginName()

const char * SBAttachInfo::GetProcessPluginName ( )

Definition at line 94 of file SBAttachInfo.cpp.

References LLDB_RECORD_METHOD_NO_ARGS, and m_opaque_sp.

◆ GetResumeCount()

uint32_t SBAttachInfo::GetResumeCount ( )

Definition at line 82 of file SBAttachInfo.cpp.

References LLDB_RECORD_METHOD_NO_ARGS, and m_opaque_sp.

◆ GetUserID()

uint32_t SBAttachInfo::GetUserID ( )

Definition at line 158 of file SBAttachInfo.cpp.

References LLDB_RECORD_METHOD_NO_ARGS, and m_opaque_sp.

◆ GetWaitForLaunch()

bool SBAttachInfo::GetWaitForLaunch ( )

Definition at line 126 of file SBAttachInfo.cpp.

References LLDB_RECORD_METHOD_NO_ARGS, and m_opaque_sp.

◆ GroupIDIsValid()

bool SBAttachInfo::GroupIDIsValid ( )

Definition at line 176 of file SBAttachInfo.cpp.

References LLDB_RECORD_METHOD_NO_ARGS, and m_opaque_sp.

◆ operator=()

SBAttachInfo & SBAttachInfo::operator= ( const SBAttachInfo rhs)

◆ ParentProcessIDIsValid()

bool SBAttachInfo::ParentProcessIDIsValid ( )

Definition at line 243 of file SBAttachInfo.cpp.

References LLDB_RECORD_METHOD_NO_ARGS, and m_opaque_sp.

◆ ref()

lldb_private::ProcessAttachInfo & SBAttachInfo::ref ( )
protected

Definition at line 59 of file SBAttachInfo.cpp.

References m_opaque_sp.

Referenced by lldb::SBTarget::Attach().

◆ SetEffectiveGroupID()

void SBAttachInfo::SetEffectiveGroupID ( uint32_t  gid)

Definition at line 224 of file SBAttachInfo.cpp.

References LLDB_RECORD_METHOD, and m_opaque_sp.

◆ SetEffectiveUserID()

void SBAttachInfo::SetEffectiveUserID ( uint32_t  uid)

Definition at line 218 of file SBAttachInfo.cpp.

References LLDB_RECORD_METHOD, and m_opaque_sp.

◆ SetExecutable() [1/2]

void SBAttachInfo::SetExecutable ( const char *  path)

Definition at line 107 of file SBAttachInfo.cpp.

References LLDB_RECORD_METHOD, and m_opaque_sp.

Referenced by SetExecutable().

◆ SetExecutable() [2/2]

void SBAttachInfo::SetExecutable ( lldb::SBFileSpec  exe_file)

◆ SetGroupID()

void SBAttachInfo::SetGroupID ( uint32_t  gid)

Definition at line 188 of file SBAttachInfo.cpp.

References LLDB_RECORD_METHOD, and m_opaque_sp.

◆ SetIgnoreExisting()

void SBAttachInfo::SetIgnoreExisting ( bool  b)

Definition at line 152 of file SBAttachInfo.cpp.

References LLDB_RECORD_METHOD, and m_opaque_sp.

◆ SetListener()

void SBAttachInfo::SetListener ( SBListener listener)

Set the listener that will be used to receive process events.

By default the SBDebugger, which has a listener, that the SBTarget belongs to will listen for the process events. Calling this function allows a different listener to be used to listen for process events.

Definition at line 255 of file SBAttachInfo.cpp.

References lldb::SBListener::GetSP(), LLDB_RECORD_METHOD, and m_opaque_sp.

◆ SetParentProcessID()

void SBAttachInfo::SetParentProcessID ( lldb::pid_t  pid)

Definition at line 236 of file SBAttachInfo.cpp.

References LLDB_RECORD_METHOD, and m_opaque_sp.

◆ SetProcessID()

void SBAttachInfo::SetProcessID ( lldb::pid_t  pid)

Definition at line 76 of file SBAttachInfo.cpp.

References LLDB_RECORD_METHOD, and m_opaque_sp.

◆ SetProcessPluginName()

void SBAttachInfo::SetProcessPluginName ( const char *  plugin_name)

Definition at line 100 of file SBAttachInfo.cpp.

References LLDB_RECORD_METHOD, and m_opaque_sp.

◆ SetResumeCount()

void SBAttachInfo::SetResumeCount ( uint32_t  c)

Definition at line 88 of file SBAttachInfo.cpp.

References LLDB_RECORD_METHOD, and m_opaque_sp.

◆ SetUserID()

void SBAttachInfo::SetUserID ( uint32_t  uid)

Definition at line 182 of file SBAttachInfo.cpp.

References LLDB_RECORD_METHOD, and m_opaque_sp.

◆ SetWaitForLaunch() [1/2]

void SBAttachInfo::SetWaitForLaunch ( bool  b)

Set attach by process name settings.

Designed to be used after a call to SBAttachInfo::SetExecutable(). This function implies that a call to SBTarget::Attach(...) will be synchronous.

Parameters
[in]bIf false, attach to an existing process whose name matches. If true, then wait for the next process whose name matches.

Definition at line 132 of file SBAttachInfo.cpp.

References LLDB_RECORD_METHOD, and m_opaque_sp.

Referenced by SetWaitForLaunch().

◆ SetWaitForLaunch() [2/2]

void SBAttachInfo::SetWaitForLaunch ( bool  b,
bool  async 
)

Set attach by process name settings.

Designed to be used after a call to SBAttachInfo::SetExecutable(). Future calls to SBTarget::Attach(...) will be synchronous or asynchronous depending on the async argument.

Parameters
[in]bIf false, attach to an existing process whose name matches. If true, then wait for the next process whose name matches.
[in]asyncIf false, then the SBTarget::Attach(...) call will be a synchronous call with no way to cancel the attach in progress. If true, then the SBTarget::Attach(...) function will return immediately and clients are expected to wait for a process eStateStopped event if a suitable process is eventually found. If the client wants to cancel the event, SBProcess::Stop() can be called and an eStateExited process event will be delivered.

Definition at line 138 of file SBAttachInfo.cpp.

References LLDB_RECORD_METHOD, m_opaque_sp, and SetWaitForLaunch().

◆ UserIDIsValid()

bool SBAttachInfo::UserIDIsValid ( )

Definition at line 170 of file SBAttachInfo.cpp.

References LLDB_RECORD_METHOD_NO_ARGS, and m_opaque_sp.

Friends And Related Function Documentation

◆ SBTarget

friend class SBTarget
friend

Definition at line 168 of file SBAttachInfo.h.

Member Data Documentation

◆ m_opaque_sp

ProcessAttachInfoSP lldb::SBAttachInfo::m_opaque_sp
protected

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