Files
2026-07-13 13:02:50 +08:00

74 lines
2.1 KiB
C#

/*
* QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals.
* Lean Algorithmic Trading Engine v2.0. Copyright 2014 QuantConnect Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
using System;
namespace QuantConnect.Brokerages
{
/// <summary>
/// Wrapper for WebSocket4Net to enhance testability
/// </summary>
public interface IWebSocket
{
/// <summary>
/// Wraps constructor
/// </summary>
/// <param name="url">The target websocket url</param>
/// <param name="sessionToken">The websocket session token</param>
void Initialize(string url, string sessionToken = null);
/// <summary>
/// Wraps send method
/// </summary>
/// <param name="data"></param>
void Send(string data);
/// <summary>
/// Wraps Connect method
/// </summary>
void Connect();
/// <summary>
/// Wraps Close method
/// </summary>
void Close();
/// <summary>
/// Wraps IsOpen
/// </summary>
bool IsOpen { get; }
/// <summary>
/// on message event
/// </summary>
event EventHandler<WebSocketMessage> Message;
/// <summary>
/// On error event
/// </summary>
event EventHandler<WebSocketError> Error;
/// <summary>
/// On Open event
/// </summary>
event EventHandler Open;
/// <summary>
/// On Close event
/// </summary>
event EventHandler<WebSocketCloseData> Closed;
}
}