Создание собственного коннектора

Механизм сообщений является внутренним логическим слоем архитектуры StockSharp, который обеспечивает взаимодействие различных элементов платформы по стандартному протоколу.

Выделяются два основных класса:

Message - сообщение, несущее в себе информацию.
AsyncMessageAdapter - адаптер (=преобразователь) сообщений.

Сообщение выполняет роль агента, передающего информацию. Сообщения имеют свой тип MessageTypes. Каждому типу сообщения соответствует определенный класс. В свою очередь все классы сообщений наследуют от абстрактного класса Message, который наделяет потомков такими свойствами, как тип сообщения Message.Type и Message.LocalTime - локальное время создания/получения сообщения.

Сообщения могут быть входящими и исходящими:

Входящие сообщения - сообщения, которые посылаются во внешнюю систему. Обычно это команды, которые генерирует программа, например, сообщение ConnectMessage - команда, запрашивающая соединение с сервером.
Исходящие сообщения - сообщения, поступающие из внешней системы. Это сообщения, передающие информацию о рыночных данных, транзакциях, портфелях, событиях соединения и т.п. Например, сообщение QuoteChangeMessage - передает информацию об изменении стакана.

Адаптер сообщений играет роль посредника между торговой системой и программой. Для каждого типа коннектора имеется свой класс адаптера, который наследуется от абстрактного класса AsyncMessageAdapter.

Адаптер выполняет две основные функции:

Преобразует входящие сообщения в команды конкретной торговой системы.
Преобразует информацию, поступающую от торговой системы (соединение, рыночные данные, транзакции и т.п.), в исходящие сообщения.

Ниже описан процесс создания собственного адаптера для Coinbase (все коннекторы с исходным кодом доступны в репозитории StockSharp и предоставляются как учебное пособие).

Пример создания адаптера сообщений Coinbase

1. Создание класса адаптера

Вначале создаем класс адаптера сообщений CoinbaseMessageAdapter, унаследованный от абстрактного класса AsyncMessageAdapter.

public partial class CoinbaseMessageAdapter : AsyncMessageAdapter
{
    private Authenticator _authenticator;
    private HttpClient _restClient;
    private SocketClient _socketClient;

    // Другие поля и свойства адаптера
}

2. Конструктор адаптера

В конструкторе адаптера необходимо выполнить следующие действия:

Передать генератор идентификаторов транзакций, который будет использоваться для создания идентификаторов сообщений.
Указать поддерживаемые типы сообщений с помощью методов:

AddMarketDataSupport - поддержка сообщений для подписки на рыночные данные.
AddTransactionalSupport - поддержка транзакционных сообщений.

Указать конкретные типы рыночных данных, которые поддерживает адаптер, с помощью метода AddSupportedMarketDataType.
Указать типы результирующих сообщений, которые будут поддерживаться адаптером, с помощью метода AddSupportedResultMessage. Такие типы сообщений как SecurityLookupMessage, PortfolioLookupMessage, OrderStatusMessage и т.п. запрашивают информацию у коннектора и ожидают соответствующих ответных сообщений.

public CoinbaseMessageAdapter(IdGenerator transactionIdGenerator)
    : base(transactionIdGenerator)
{
    HeartbeatInterval = TimeSpan.FromSeconds(5);

    // Добавление поддержки рыночных данных и транзакций
    this.AddMarketDataSupport();
    this.AddTransactionalSupport();

    // Удаление неподдерживаемых типов сообщений
    this.RemoveSupportedMessage(MessageTypes.Portfolio);
    this.RemoveSupportedMessage(MessageTypes.OrderGroupCancel);

    // Добавление поддерживаемых типов рыночных данных
    this.AddSupportedMarketDataType(DataType.Ticks);
    this.AddSupportedMarketDataType(DataType.MarketDepth);
    this.AddSupportedMarketDataType(DataType.Level1);
    this.AddSupportedMarketDataType(DataType.CandleTimeFrame);

    // Добавление поддерживаемых результирующих сообщений
    this.AddSupportedResultMessage(MessageTypes.SecurityLookup);
    this.AddSupportedResultMessage(MessageTypes.PortfolioLookup);
    this.AddSupportedResultMessage(MessageTypes.OrderStatus);
}

3. Подключение и отключение адаптера

Для подключения адаптера к торговой системе вызывается метод AsyncMessageAdapter.ConnectAsync. В него передается входящее сообщение ConnectMessage, при успешном соединении адаптер отправляет исходящее сообщение ConnectMessage:

public override async ValueTask ConnectAsync(ConnectMessage connectMsg, CancellationToken cancellationToken)
{
    // Проверка наличия ключей для транзакционного режима
    if (this.IsTransactional())
    {
        if (Key.IsEmpty())
            throw new InvalidOperationException(LocalizedStrings.KeyNotSpecified);

        if (Secret.IsEmpty())
            throw new InvalidOperationException(LocalizedStrings.SecretNotSpecified);
    }

    // Инициализация аутентификатора
    _authenticator = new(this.IsTransactional(), Key, Secret, Passphrase);

    // Проверка, что клиенты еще не созданы
    if (_restClient != null)
        throw new InvalidOperationException(LocalizedStrings.NotDisconnectPrevTime);

    if (_socketClient != null)
        throw new InvalidOperationException(LocalizedStrings.NotDisconnectPrevTime);

    // Создание REST клиента
    _restClient = new(_authenticator) { Parent = this };

    // Создание и настройка WebSocket клиента
    _socketClient = new(_authenticator, ReConnectionSettings.ReAttemptCount) { Parent = this };
    SubscribePusherClient();

    // Подключение WebSocket клиента
    await _socketClient.Connect(cancellationToken);

    // Отправка сообщения об успешном подключении
    SendOutMessage(new ConnectMessage());
}

Для отключения адаптера от торговой системы вызывается метод AsyncMessageAdapter.DisconnectAsync. При успешном отключении адаптер отправляет исходящее сообщение DisconnectMessage:

public override ValueTask DisconnectAsync(DisconnectMessage disconnectMsg, CancellationToken cancellationToken)
{
    // Проверка, что клиенты созданы
    if (_restClient == null)
        throw new InvalidOperationException(LocalizedStrings.ConnectionNotOk);

    if (_socketClient == null)
        throw new InvalidOperationException(LocalizedStrings.ConnectionNotOk);

    // Освобождение ресурсов REST клиента
    _restClient.Dispose();
    _restClient = null;

    // Отключение WebSocket клиента
    _socketClient.Disconnect();

    // Отправка сообщения об отключении
    SendOutDisconnectMessage(true);
    return default;
}

Дополнительно адаптер предоставляет метод AsyncMessageAdapter.ResetAsync для сброса состояния, который закрывает соединение и возвращает адаптер в исходное состояние:

public override ValueTask ResetAsync(ResetMessage resetMsg, CancellationToken cancellationToken)
{
    // Освобождение ресурсов REST клиента
    if (_restClient != null)
    {
        try
        {
            _restClient.Dispose();
        }
        catch (Exception ex)
        {
            SendOutError(ex);
        }

        _restClient = null;
    }

    // Отключение и очистка WebSocket клиента
    if (_socketClient != null)
    {
        try
        {
            UnsubscribePusherClient();
            _socketClient.Disconnect();
        }
        catch (Exception ex)
        {
            SendOutError(ex);
        }

        _socketClient = null;
    }

    // Освобождение ресурсов аутентификатора
    if (_authenticator != null)
    {
        try
        {
            _authenticator.Dispose();
        }
        catch (Exception ex)
        {
            SendOutError(ex);
        }

        _authenticator = null;
    }

    // Очистка дополнительных данных
    _candlesTransIds.Clear();

    // Отправка сообщения о сбросе
    SendOutMessage(new ResetMessage());
    return default;
}

Этот документ описывает общие принципы работы адаптера, его создание и управление соединением с торговой системой. Следующие документы будут посвящены реализации функционала адаптера:

Table of Contents

Создание собственного коннектора

Пример создания адаптера сообщений Coinbase

1. Создание класса адаптера

2. Конструктор адаптера

3. Подключение и отключение адаптера