AgentCore Class

Article
10/08/2015

Implements the core functionality for managed replication agents.

Inheritance Hierarchy

Object
  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
	AgentCore	Creates a new instance of the AgentCore class.

Top

Properties

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

Top

Methods

	Name	Description
	Abort	Aborts the process of the current instance.
	CreateObjRef	Security Critical. (Inherited from MarshalByRefObject.)
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetLifetimeService	Security Critical. (Inherited from MarshalByRefObject.)
	GetType	(Inherited from Object.)
	InitializeLifetimeService	Security Critical. (Inherited from MarshalByRefObject.)
	MemberwiseClone	(Inherited from Object.)
	MemberwiseClone(Boolean)	(Inherited from MarshalByRefObject.)
	ResetParametersToDefault	Resets the value of the parameters to default.
	ToString	(Inherited from Object.)

Top

Events

	Name	Description
	ComStatus	Infrastructure. Occurs when a running agent returns synchronization Com status information.
	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.

Share via