Otter SDK Reference
Version:

OtterAgent Class

The base class for all agents.

Inheritance Hierarchy

  • object
    • Inedo.Otter.Extensibility.Agents.OtterAgent

Syntax

public class OtterAgent : System.IDisposable

Constructors

Name Description
OtterAgent

Initializes a new instance of the OtterAgent class.

OtterAgent(bool simulated)

Initializes a new instance of the OtterAgent class.

Properties

Name Description
Simulated

Gets a value indicating whether the agent is running in simulated mode.

Methods

Name Description
Create(string serverName)

Creates an agent from the specified server name

Create(string serverName, bool simulated)

Creates an agent from the specified server name

Create(int serverId)

Creates an agent from the specified serverId

Create(int serverId, bool simulated)

Creates an agent from the specified serverId

Create(Inedo.Otter.Data.Tables.Servers_Extended serverInfo)
Create(Inedo.Otter.Data.Tables.Servers_Extended serverInfo, bool simulated)
Dispose

Releases resources used by the agent and closes open connections.

Dispose(bool disposing)

Releases resources used by the agent.

GetAgentServiceInternal<TService>

Returns an instance of the requested agent service if it is supported; otherwise returns null (Nothing in Visual Basic).

GetDescription

Returns a description of the agent and its current configuration.

GetService<TService>

Returns the requested agent service or throws an exception if it is not available.

GetServiceAsync<TService>

Returns the requested agent service or throws an exception if it is not available.

TryGetService<TService>

Returns the requested agent service interface if it is supported; otherwise returns null (Nothing in Visual Basic).

TryGetServiceAsync<TService>

Returns the requested agent service interface if it is supported; otherwise returns null (Nothing in Visual Basic).

Remarks

An agent brokers communication between Otter and servers.