kCura.Agent.IAgentBaseProxy

IAgentBaseProxy

public interface IAgentBaseProxy : IDisposable

An interface used for working with agents.

Documentation

public sealed delegate OnAgentDisabledEventHandler : MulticastDelegate

public sealed delegate OnAgentDisposeEventHandler : MulticastDelegate

public sealed delegate OnAgentEnableEventHandler : MulticastDelegate

public sealed delegate OnAgentExecuteBeginEventHandler : MulticastDelegate

public sealed delegate OnAgentExecuteExceptionEventHandler : MulticastDelegate

public sealed delegate OnAgentExecuteFinishEventHandler : MulticastDelegate

public sealed delegate OnMessageEventHandler : MulticastDelegate

string AssemblyPath { get; }

This read-only property returns an assembly path value of a given agent instance.

string ClassName { get; }

This read-only property returns class name used to define agent instance name.

bool Enabled { get; set; }

Property which indicates if an agent instance is enabled.

bool Executing { get; }

This read-only property Returns the flag indicating whether a given agent instance is currently running a task or not.

double Interval { get; }

This read-only property returns a value expressed in seconds describing an interval a given agent instance will perform its check-ins.

bool IsHealthy { get; }

This ReadOnly property Returns the flag indicating whether a given agent is healthy.

AgentMessage LastMessage { get; }

This read-only property implements IAgentBaseProxy.LastMessage

int LoggingLevel { get; set; }

This property gets/sets logging level of a given agent instance.

string Name { get; }

This read-only property returns an agent instance name.

DateTime StartTime { get; }

Gets the start time.

bool ToBeRemoved { get; set; }

This property marks an agent instance to be deleted once its resources are released.

bool UseFixedInterval { get; set; }

This property sets an agent instace to check in on a fixed time interval.

event OnAgentDisabledEventHandler OnAgentDisabled

This event is raised when agent gets disabled.

event OnAgentDisposeEventHandler OnAgentDispose

This event is raised upon agent disposal.

event OnAgentEnableEventHandler OnAgentEnable

This event is raised when agent gets enabled.

event OnAgentExecuteBeginEventHandler OnAgentExecuteBegin

This event is raised when agent starts executing.

event OnAgentExecuteExceptionEventHandler OnAgentExecuteException

This event is raised when agent execution throws an exception.

event OnAgentExecuteFinishEventHandler OnAgentExecuteFinish

This event is raised when agent execution completes.

event OnMessageEventHandler OnMessage

Event used to pass messages between Winform/Windows Service and AgentBase.

void HandleOnAgentDisabled()

This sub implements handler for event OnAgentDisabled.

void HandleOnAgentEnable()

This sub implements handler for event OnAgentEnable.

void HandleOnAgentExecuteBegin()

This sub implements handler for event OnAgentExecuteBegin.

void HandleOnAgentExecuteException()

This sub implements handler for OnAgentExecuteException event.

void HandleOnAgentExecuteFinish()

This sub implements handler for OnAgentExecuteFinish event.

void HandleOnMessage(AgentMessage message)

Handler for OnMessage event.

void Initialize(string Path, string assemblyName)

This sub is used to instantiate local assembly and agent objects.

void SetClassInfo(string assemblyPath, string className, int agentID, ILicenseMgr licenseMgrProxy, AgentType serviceType)

This sub sets basic agent properties - assembly path, class name and agent id.

double SetInterval(double value)

This sub sets an interval of an agent instance.

void SetReference(ref IAgentBaseProxy passBack)

This sub sets a reference between two objects of same type to enable 2-way cross-app domain communication.

void UpdateIsShuttingDown()

This sub sets agent shut down to true when agent shuts down or restarts.