AgentCore Class

Implements the core functionality for managed replication agents.

Inheritance Hierarchy

System.Object
  System.MarshalByRefObject
    Microsoft.SqlServer.Replication.AgentCore
      Microsoft.SqlServer.Replication.SnapshotGenerationAgent

Namespace:  Microsoft.SqlServer.Replication
Assembly:  Microsoft.SqlServer.Replication (in Microsoft.SqlServer.Replication.dll)

Syntax

'Declaration
<ComVisibleAttribute(True)> _
<StrongNameIdentityPermissionAttribute(SecurityAction.InheritanceDemand, Name := "Microsoft.SqlServer.Replication",  _
    PublicKey := "0024000004800000940000000602000000240000525341310004000001000100272736ad6e5f9586bac2d531eabc3acc666c2f8ec879fa94f8f7b0327d2ff2ed523448f83c3d5c5dd2dfc7bc99c5286b2c125117bf5cbe242b9d41750732b2bdffe649c6efb8e5526d526fdd130095ecdb7bf210809c6cdad8824faa9ac0310ac3cba2aa0523567b2dfa7fe250b30facbd62d4ec99b94ac47c7d3b28f1f6e4c8")> _
Public MustInherit Class AgentCore _
    Inherits MarshalByRefObject
'Usage
Dim instance As AgentCore
[ComVisibleAttribute(true)]
[StrongNameIdentityPermissionAttribute(SecurityAction.InheritanceDemand, Name = "Microsoft.SqlServer.Replication", 
    PublicKey = "0024000004800000940000000602000000240000525341310004000001000100272736ad6e5f9586bac2d531eabc3acc666c2f8ec879fa94f8f7b0327d2ff2ed523448f83c3d5c5dd2dfc7bc99c5286b2c125117bf5cbe242b9d41750732b2bdffe649c6efb8e5526d526fdd130095ecdb7bf210809c6cdad8824faa9ac0310ac3cba2aa0523567b2dfa7fe250b30facbd62d4ec99b94ac47c7d3b28f1f6e4c8")]
public abstract class AgentCore : MarshalByRefObject
[ComVisibleAttribute(true)]
[StrongNameIdentityPermissionAttribute(SecurityAction::InheritanceDemand, Name = L"Microsoft.SqlServer.Replication", 
    PublicKey = L"0024000004800000940000000602000000240000525341310004000001000100272736ad6e5f9586bac2d531eabc3acc666c2f8ec879fa94f8f7b0327d2ff2ed523448f83c3d5c5dd2dfc7bc99c5286b2c125117bf5cbe242b9d41750732b2bdffe649c6efb8e5526d526fdd130095ecdb7bf210809c6cdad8824faa9ac0310ac3cba2aa0523567b2dfa7fe250b30facbd62d4ec99b94ac47c7d3b28f1f6e4c8")]
public ref class AgentCore abstract : public MarshalByRefObject
[<AbstractClassAttribute>]
[<ComVisibleAttribute(true)>]
[<StrongNameIdentityPermissionAttribute(SecurityAction.InheritanceDemand, Name = "Microsoft.SqlServer.Replication", 
    PublicKey = "0024000004800000940000000602000000240000525341310004000001000100272736ad6e5f9586bac2d531eabc3acc666c2f8ec879fa94f8f7b0327d2ff2ed523448f83c3d5c5dd2dfc7bc99c5286b2c125117bf5cbe242b9d41750732b2bdffe649c6efb8e5526d526fdd130095ecdb7bf210809c6cdad8824faa9ac0310ac3cba2aa0523567b2dfa7fe250b30facbd62d4ec99b94ac47c7d3b28f1f6e4c8")>]
type AgentCore =  
    class
        inherit MarshalByRefObject
    end
public abstract class AgentCore extends MarshalByRefObject

The AgentCore type exposes the following members.

Constructors

  Name Description
Protected method AgentCore Creates an instance of the AgentCore class.

Top

Properties

  Name Description
Public property AbortPolicy Gets or sets how running replication agent threads are terminated when an unanticipated shutdown occurs.
Public property ComErrorCollection Returns information on errors that occur during agent execution.
Public property FlatExceptionCollection Infrastructure.
Public property HistoryVerboseLevel Gets or sets the amount of history logged during agent execution.
Public property LoginTimeout Get or sets the number of seconds before the login times out for connections made by the agent.
Public property Output Get or sets the name and path of the agent output file.
Public property OutputVerboseLevel Gets or sets the level of detail of information written to the agent output file.
Public property PacketSize Infrastructure.
Public property ProfileName Gets or sets an agent profile to use when running the agent.
Public property PublisherFailoverPartner Gets or sets the failover partner instance of SQL Server participating in a database mirroring session with the publication database.
Public property QueryTimeout Get or sets the number of seconds before a query times out.

Top

Methods

  Name Description
Public method Abort
Public method CreateObjRef (Inherited from MarshalByRefObject.)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetLifetimeService (Inherited from MarshalByRefObject.)
Public method GetType (Inherited from Object.)
Public method InitializeLifetimeService (Inherited from MarshalByRefObject.)
Protected method MemberwiseClone() (Inherited from Object.)
Protected method MemberwiseClone(Boolean) (Inherited from MarshalByRefObject.)
Public method ResetParametersToDefault
Public method ToString (Inherited from Object.)

Top

Events

  Name Description
Public event ComStatus
Public event Status Occurs when a running agent returns status information.

Top

Remarks

Do not use AgentCore. Instead use the derived agent classes SnapshotGenerationAgent, MergeSynchronizationAgent, and TransSynchronizationAgent.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.