LLDB API Documentation

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)
 
 SBAttachInfo (const char *path, bool wait_for, bool async)
 
 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)
 
void SetWaitForLaunch (bool b, bool async)
 
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 ()
 
void SetListener (SBListener &listener)
 

Protected Member Functions

lldb_private::ProcessAttachInfo & ref ()
 

Protected Attributes

ProcessAttachInfoSP m_opaque_sp
 

Friends

class SBTarget
 

Detailed Description

Definition at line 19 of file SBAttachInfo.h.

Constructor & Destructor Documentation

lldb::SBAttachInfo::SBAttachInfo ( )
lldb::SBAttachInfo::SBAttachInfo ( lldb::pid_t  pid)
lldb::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.
lldb::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.
lldb::SBAttachInfo::SBAttachInfo ( const SBAttachInfo rhs)
lldb::SBAttachInfo::~SBAttachInfo ( )

Member Function Documentation

bool lldb::SBAttachInfo::EffectiveGroupIDIsValid ( )
bool lldb::SBAttachInfo::EffectiveUserIDIsValid ( )
uint32_t lldb::SBAttachInfo::GetEffectiveGroupID ( )
uint32_t lldb::SBAttachInfo::GetEffectiveUserID ( )
uint32_t lldb::SBAttachInfo::GetGroupID ( )
bool lldb::SBAttachInfo::GetIgnoreExisting ( )
SBListener lldb::SBAttachInfo::GetListener ( )

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

If no listener has been set via a call to SBLaunchInfo::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.

lldb::pid_t lldb::SBAttachInfo::GetParentProcessID ( )
lldb::pid_t lldb::SBAttachInfo::GetProcessID ( )
const char* lldb::SBAttachInfo::GetProcessPluginName ( )
uint32_t lldb::SBAttachInfo::GetResumeCount ( )
uint32_t lldb::SBAttachInfo::GetUserID ( )
bool lldb::SBAttachInfo::GetWaitForLaunch ( )
bool lldb::SBAttachInfo::GroupIDIsValid ( )
SBAttachInfo& lldb::SBAttachInfo::operator= ( const SBAttachInfo rhs)
bool lldb::SBAttachInfo::ParentProcessIDIsValid ( )
lldb_private::ProcessAttachInfo& lldb::SBAttachInfo::ref ( )
protected
void lldb::SBAttachInfo::SetEffectiveGroupID ( uint32_t  gid)
void lldb::SBAttachInfo::SetEffectiveUserID ( uint32_t  uid)
void lldb::SBAttachInfo::SetExecutable ( const char *  path)
void lldb::SBAttachInfo::SetExecutable ( lldb::SBFileSpec  exe_file)
void lldb::SBAttachInfo::SetGroupID ( uint32_t  gid)
void lldb::SBAttachInfo::SetIgnoreExisting ( bool  b)
void lldb::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.

void lldb::SBAttachInfo::SetParentProcessID ( lldb::pid_t  pid)
void lldb::SBAttachInfo::SetProcessID ( lldb::pid_t  pid)
void lldb::SBAttachInfo::SetProcessPluginName ( const char *  plugin_name)
void lldb::SBAttachInfo::SetResumeCount ( uint32_t  c)
void lldb::SBAttachInfo::SetUserID ( uint32_t  uid)
void lldb::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]wait_forIf false, attach to an existing process whose name matches. If true, then wait for the next process whose name matches.
void lldb::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]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.
bool lldb::SBAttachInfo::UserIDIsValid ( )

Friends And Related Function Documentation

friend class SBTarget
friend

Definition at line 181 of file SBAttachInfo.h.

Member Data Documentation

ProcessAttachInfoSP lldb::SBAttachInfo::m_opaque_sp
protected

Definition at line 185 of file SBAttachInfo.h.


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