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

SendDeploymentUpdateResultAsync(RtEntityId, DeploymentResult)​

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

Task SendDeploymentUpdateResultAsync(RtEntityId adapterRtEntityId, DeploymentResult deploymentResult)

Parameters​

adapterRtEntityId RtEntityId
Object identifier of the adapter

deploymentResult DeploymentResult
The result of the deployment

Returns​

Task

ReportExecutionStartAsync(PipelineExecutionStartDto)​

Reports the start of a pipeline execution to the communication controller.

Task ReportExecutionStartAsync(PipelineExecutionStartDto startDto)

Parameters​

startDto PipelineExecutionStartDto
Details about the execution start

Returns​

Task

ReportExecutionEndAsync(PipelineExecutionEndDto)​

Reports the end of a pipeline execution to the communication controller.

Task ReportExecutionEndAsync(PipelineExecutionEndDto endDto)

Parameters​

endDto PipelineExecutionEndDto
Details about the execution end including status and duration

Returns​

Task

ReportInterruptedExecutionResultAsync(PipelineExecutionEndDto)​

Reports the final result of an execution that was previously marked as interrupted. Called after adapter reconnects to update the final status of interrupted executions.

Task ReportInterruptedExecutionResultAsync(PipelineExecutionEndDto endDto)

Parameters​

endDto PipelineExecutionEndDto
Details about the execution end

Returns​

Task

GetInterruptedExecutionIdsAsync()​

Gets the list of execution IDs that were marked as interrupted when this adapter disconnected. Called after reconnection to determine which executions need their final status reported.

Task<IReadOnlyList<string>> GetInterruptedExecutionIdsAsync()

Returns​

Task<IReadOnlyList<String>>
List of execution IDs that are in interrupted state