mirror of
https://github.com/wiremock/WireMock.Net.git
synced 2026-02-25 10:15:04 +01:00
06b5a7ab84
* WireMock.Net.RestClient.AwesomeAssertions * ok * atpath * fix test * sonar fixes * ports
104 lines
3.0 KiB
C#
104 lines
3.0 KiB
C#
// Copyright © WireMock.Net
|
|
|
|
using System;
|
|
using JetBrains.Annotations;
|
|
using WireMock.Matchers;
|
|
using WireMock.Settings;
|
|
using WireMock.Types;
|
|
|
|
namespace WireMock.WebSockets;
|
|
|
|
/// <summary>
|
|
/// WebSocket Response Builder interface
|
|
/// </summary>
|
|
public interface IWebSocketBuilder
|
|
{
|
|
/// <summary>
|
|
/// Accept the WebSocket with a specific protocol
|
|
/// </summary>
|
|
[PublicAPI]
|
|
IWebSocketBuilder WithAcceptProtocol(string protocol);
|
|
|
|
/// <summary>
|
|
/// Echo all received messages back to client
|
|
/// </summary>
|
|
[PublicAPI]
|
|
IWebSocketBuilder WithEcho();
|
|
|
|
/// <summary>
|
|
/// Configure and send a single message in response to any received message
|
|
/// </summary>
|
|
/// <param name="configure">Action to configure the message</param>
|
|
[PublicAPI]
|
|
IWebSocketBuilder SendMessage(Action<IWebSocketMessageBuilder> configure);
|
|
|
|
/// <summary>
|
|
/// Configure and send multiple messages in response to any received message
|
|
/// </summary>
|
|
/// <param name="configure">Action to configure the messages</param>
|
|
[PublicAPI]
|
|
IWebSocketBuilder SendMessages(Action<IWebSocketMessagesBuilder> configure);
|
|
|
|
/// <summary>
|
|
/// Configure message sending based on message content matching
|
|
/// </summary>
|
|
/// <param name="wildcardPattern">String to match in message text</param>
|
|
[PublicAPI]
|
|
IWebSocketMessageConditionBuilder WhenMessage(string wildcardPattern);
|
|
|
|
/// <summary>
|
|
/// Configure message sending based on message content matching
|
|
/// </summary>
|
|
/// <param name="exactPattern">Bytes to match in message</param>
|
|
[PublicAPI]
|
|
IWebSocketMessageConditionBuilder WhenMessage(byte[] exactPattern);
|
|
|
|
/// <summary>
|
|
/// Configure message sending based on IMatcher
|
|
/// </summary>
|
|
/// <param name="matcher">IMatcher to match the message</param>
|
|
[PublicAPI]
|
|
IWebSocketMessageConditionBuilder WhenMessage(IMatcher matcher);
|
|
|
|
/// <summary>
|
|
/// Handle incoming WebSocket messages
|
|
/// </summary>
|
|
[PublicAPI]
|
|
IWebSocketBuilder WithMessageHandler(Func<WebSocketMessage, IWebSocketContext, Task> handler);
|
|
|
|
/// <summary>
|
|
/// Enable broadcast mode for this mapping
|
|
/// </summary>
|
|
[PublicAPI]
|
|
IWebSocketBuilder WithBroadcast();
|
|
|
|
/// <summary>
|
|
/// Proxy to another WebSocket server
|
|
/// </summary>
|
|
[PublicAPI]
|
|
IWebSocketBuilder WithProxy(ProxyAndRecordSettings settings);
|
|
|
|
/// <summary>
|
|
/// Set close timeout (default: 10 minutes)
|
|
/// </summary>
|
|
[PublicAPI]
|
|
IWebSocketBuilder WithCloseTimeout(TimeSpan timeout);
|
|
|
|
/// <summary>
|
|
/// Set maximum message size in bytes (default: 1 MB)
|
|
/// </summary>
|
|
[PublicAPI]
|
|
IWebSocketBuilder WithMaxMessageSize(int sizeInBytes);
|
|
|
|
/// <summary>
|
|
/// Set receive buffer size (default: 4096 bytes)
|
|
/// </summary>
|
|
[PublicAPI]
|
|
IWebSocketBuilder WithReceiveBufferSize(int sizeInBytes);
|
|
|
|
/// <summary>
|
|
/// Set keep-alive interval (default: 30 seconds)
|
|
/// </summary>
|
|
[PublicAPI]
|
|
IWebSocketBuilder WithKeepAliveInterval(TimeSpan interval);
|
|
} |