Add configuration for maximum receive buffer size to NetworkTransport (#146)

This commit is contained in:
Mattt 2025-07-08 14:48:29 -07:00 • committed by GitHub
commit 494b5b55d3
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -48,6 +48,12 @@ import Logging
/// // Initialize the transport with the connection /// // Initialize the transport with the connection
/// let transport = NetworkTransport(connection: connection) /// let transport = NetworkTransport(connection: connection)
/// ///
/// // For large messages (e.g., images), configure unlimited buffer size
/// let largeBufferTransport = NetworkTransport(
/// connection: connection,
/// bufferConfig: .unlimited
/// )
///
/// // Use the transport with an MCP client /// // Use the transport with an MCP client
/// let client = Client(name: "MyApp", version: "1.0.0") /// let client = Client(name: "MyApp", version: "1.0.0")
/// try await client.connect(transport: transport) /// try await client.connect(transport: transport)
@ -207,6 +213,26 @@ import Logging
} }
} }
/// Configuration for buffer behavior.
public struct BufferConfiguration: Hashable, Sendable {
/// Maximum buffer size for receiving data chunks.
/// Set to nil for unlimited (uses system default).
public let maxReceiveBufferSize: Int?
/// Creates a new buffer configuration.
///
/// - Parameter maxReceiveBufferSize: Maximum buffer size in bytes (default: 10MB, nil for unlimited)
public init(maxReceiveBufferSize: Int? = 10 * 1024 * 1024) {
self.maxReceiveBufferSize = maxReceiveBufferSize
}
/// Default buffer configuration with 10MB limit.
public static let `default` = BufferConfiguration()
/// Configuration with no buffer size limit.
public static let unlimited = BufferConfiguration(maxReceiveBufferSize: nil)
}
// State tracking // State tracking
private var isConnected = false private var isConnected = false
private var isStopping = false private var isStopping = false
@ -228,6 +254,7 @@ import Logging
// Configuration // Configuration
private let heartbeatConfig: HeartbeatConfiguration private let heartbeatConfig: HeartbeatConfiguration
private let reconnectionConfig: ReconnectionConfiguration private let reconnectionConfig: ReconnectionConfiguration
private let bufferConfig: BufferConfiguration
/// Creates a new NetworkTransport with the specified NWConnection /// Creates a new NetworkTransport with the specified NWConnection
/// ///
@ -236,17 +263,20 @@ import Logging
/// - logger: Optional logger instance for transport events /// - logger: Optional logger instance for transport events
/// - reconnectionConfig: Configuration for reconnection behavior (default: .default) /// - reconnectionConfig: Configuration for reconnection behavior (default: .default)
/// - heartbeatConfig: Configuration for heartbeat behavior (default: .default) /// - heartbeatConfig: Configuration for heartbeat behavior (default: .default)
/// - bufferConfig: Configuration for buffer behavior (default: .default)
public init( public init(
connection: NWConnection, connection: NWConnection,
logger: Logger? = nil, logger: Logger? = nil,
heartbeatConfig: HeartbeatConfiguration = .default, heartbeatConfig: HeartbeatConfiguration = .default,
reconnectionConfig: ReconnectionConfiguration = .default reconnectionConfig: ReconnectionConfiguration = .default,
bufferConfig: BufferConfiguration = .default
) { ) {
self.init( self.init(
connection, connection,
logger: logger, logger: logger,
heartbeatConfig: heartbeatConfig, heartbeatConfig: heartbeatConfig,
reconnectionConfig: reconnectionConfig reconnectionConfig: reconnectionConfig,
bufferConfig: bufferConfig
) )
} }
@ -254,7 +284,8 @@ import Logging
_ connection: NetworkConnectionProtocol, _ connection: NetworkConnectionProtocol,
logger: Logger? = nil, logger: Logger? = nil,
heartbeatConfig: HeartbeatConfiguration = .default, heartbeatConfig: HeartbeatConfiguration = .default,
reconnectionConfig: ReconnectionConfiguration = .default reconnectionConfig: ReconnectionConfiguration = .default,
bufferConfig: BufferConfiguration = .default
) { ) {
self.connection = connection self.connection = connection
self.logger = self.logger =
@ -265,6 +296,7 @@ import Logging
) )
self.reconnectionConfig = reconnectionConfig self.reconnectionConfig = reconnectionConfig
self.heartbeatConfig = heartbeatConfig self.heartbeatConfig = heartbeatConfig
self.bufferConfig = bufferConfig
// Create message stream // Create message stream
var continuation: AsyncThrowingStream<Data, Swift.Error>.Continuation! var continuation: AsyncThrowingStream<Data, Swift.Error>.Continuation!
@ -773,7 +805,8 @@ import Logging
return return
} }
connection.receive(minimumIncompleteLength: 1, maximumLength: 65536) { let maxLength = bufferConfig.maxReceiveBufferSize ?? Int.max
connection.receive(minimumIncompleteLength: 1, maximumLength: maxLength) {
content, _, isComplete, error in content, _, isComplete, error in
Task { @MainActor in Task { @MainActor in
if !receiveContinuationResumed { if !receiveContinuationResumed {