Class AbstractEndpoint

Namespace

Steeltoe.Integration.Endpoint

Assembly

Steeltoe.Integration.IntegrationBase.dll

public abstract class AbstractEndpoint : ISmartLifecycle, ILifecycle, IPhased, IServiceNameAware

Inheritance

object

AbstractEndpoint

Implements

ISmartLifecycle

ILifecycle

IPhased

IServiceNameAware

Derived

EventDrivenConsumerEndpoint

MessageProducerSupportEndpoint

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

AbstractEndpoint(IApplicationContext)

protected AbstractEndpoint(IApplicationContext context)

Parameters

context IApplicationContext

Properties

ApplicationContext

public IApplicationContext ApplicationContext { get; }

Property Value

IApplicationContext

ComponentName

public virtual string ComponentName { get; set; }

Property Value

string

ComponentType

public virtual string ComponentType { get; set; }

Property Value

string

IntegrationServices

public IIntegrationServices IntegrationServices { get; }

Property Value

IIntegrationServices

IsAutoStartup

Gets a value indicating whether the auto startup is set for this object

public bool IsAutoStartup { get; set; }

Property Value

bool

IsRunning

Gets a value indicating whether gets a value indicating if its running

public bool IsRunning { get; set; }

Property Value

bool

Phase

Gets the phase of this object

public int Phase { get; set; }

Property Value

int

ServiceName

public virtual string ServiceName { get; set; }

Property Value

string

Methods

DoStart()

protected abstract Task DoStart()

Returns

Task

DoStop()

protected abstract Task DoStop()

Returns

Task

DoStop(Action)

protected virtual Task DoStop(Action callback)

Parameters

callback Action

Returns

Task

Start()

Start this component

public Task Start()

Returns

Task

a task to signal completion

Stop()

Stop this component

public Task Stop()

Returns

Task

a task to signal completion

Stop(Action)

Stop the component and issue the callback when complete

public Task Stop(Action callback)

Parameters

callback Action

the callback action to invoke when complete

Returns

Task

a task for completion