Share via

DkmProductionConnection Class

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Debugger.DefaultPort
Assembly:
Microsoft.VisualStudio.Debugger.Engine.dll
Package:
Microsoft.VisualStudio.Debugger.Engine v17.8.1101801

This represents a connection between the monitor and the IDE with the purpose of transporting messages related to the production scenario.

This API was introduced in Visual Studio 15 Update 2 (DkmApiVersion.VS15Update2).

public ref class DkmProductionConnection : Microsoft::VisualStudio::Debugger::DkmDataContainer, IDisposable
[System.Runtime.InteropServices.Guid("3c9f1e58-7405-5a26-86dd-f2c7156435e3")]
public class DkmProductionConnection : Microsoft.VisualStudio.Debugger.DkmDataContainer, IDisposable
[<System.Runtime.InteropServices.Guid("3c9f1e58-7405-5a26-86dd-f2c7156435e3")>]
type DkmProductionConnection = class
    inherit DkmDataContainer
    interface IDisposable
Public Class DkmProductionConnection
Inherits DkmDataContainer
Implements IDisposable
Inheritance
MarshalByRefObject
DkmDataContainer
DkmProductionConnection
Inheritance
Object
DkmDataContainer
DkmProductionConnection
Attributes
GuidAttribute
Implements
IDisposable

Properties

Connection

Connection used to send the message to the debugger. This will value is usually obtained from DkmProcess.Connection unless the message needs to be sent before the DkmProcess is created.

This API was introduced in Visual Studio 15 Update 2 (DkmApiVersion.VS15Update2).
IsUnloaded

Returns true if a 'unloaded' event has been raised for this object (example: DkmThread::Unload is called) or if the object has been closed. Note that care must be used when checking this status as, without synchronization, the returned status may no longer be accurate the instruction after it is read.

(Inherited from DkmDataContainer)
UniqueId

Guid which uniquely identifies this object.

This API was introduced in Visual Studio 15 Update 2 (DkmApiVersion.VS15Update2).

Methods

Close()

This method is called to close the object.

DkmProductionConnection objects are automatically closed when their associated DkmTransportConnection object is closed.

This API was introduced in Visual Studio 15 Update 2 (DkmApiVersion.VS15Update2).
Create(Guid, DkmTransportConnection, DkmDataItem)

DkmProductionConnection is created to connect to a production session.

This API was introduced in Visual Studio 15 Update 2 (DkmApiVersion.VS15Update2).
GetDataItem<T>()

Gets the instance of 'T' which has been added to this container instance. If this container does not contain a 'T', this function will return null.

(Inherited from DkmDataContainer)
GetProductionAgents()

GetProductionAgents enumerates the DkmProductionAgent elements of this DkmProductionConnection object.

This API was introduced in Visual Studio 15 Update 2 (DkmApiVersion.VS15Update2).
RemoveDataItem<T>()

Remove the instance of 'T' from this container. It is usually unnecessary to call this method as a data container will automatically be emptied when the object is closed.

(Inherited from DkmDataContainer)
SetDataItem<T>(DkmDataCreationDisposition, T)

Place a new item in the data container.

(Inherited from DkmDataContainer)
StartAgent(String, String, Guid)

Start an agent process with input and output redirected.

This API was introduced in Visual Studio 15 Update 2 (DkmApiVersion.VS15Update2).

Explicit Interface Implementations

IDisposable.Dispose()

To be added.

Applies to