Skip to main content

IAdapterHub

Namespace: Meshmakers.Octo.Communication.Contracts.Hubs

Interface of the adapter hub that is responsible for registering and unregistering adapters and managing their state.

public interface IAdapterHub

Methods

RegisterAdapterAsync(RtEntityId)

Registers an adapter at the communication controller

Task<AdapterConfigurationDto> RegisterAdapterAsync(RtEntityId adapterRtEntityId)

Parameters

adapterRtEntityId RtEntityId
Object identifier of the adapter

Returns

Task<AdapterConfigurationDto>

UnRegisterAdapterAsync(RtEntityId)

Unregisters an adapter from the communication controller

Task UnRegisterAdapterAsync(RtEntityId adapterRtEntityId)

Parameters

adapterRtEntityId RtEntityId
Object identifier of the adapter

Returns

Task

SendDebugDataAsync(RtEntityId, Guid, DebugPointDto)

Sends debug data to the communication controller

Task SendDebugDataAsync(RtEntityId pipelineRtEntityId, Guid pipelineExecutionId, DebugPointDto debugPoint)

Parameters

pipelineRtEntityId RtEntityId
Object identifier of the pipeline

pipelineExecutionId Guid
Guid that identifies the pipeline execution instance

debugPoint DebugPointDto
Debug information of a node execution

Returns

Task

SendDeploymentResultAsync(RtEntityId, DeploymentResult)

Updates the server about the result of an adapter configuration update.

Task SendDeploymentResultAsync(RtEntityId adapterRtEntityId, DeploymentResult deploymentResult)

Parameters

adapterRtEntityId RtEntityId
Object identifier of the adapter

deploymentResult DeploymentResult
The result of the deployment

Returns

Task