agents-core/ai.koog.agents.core.feature.remote.client.config/ClientConnectionConfig

ClientConnectionConfig

abstract class ClientConnectionConfig(val host: String, port: Int? = null, protocol: URLProtocol? = null, headers: Map<String, List<String>>? = null, val reconnectionDelay: Duration? = null, val requestTimeout: Duration? = null, val connectTimeout: Duration? = null) : ConnectionConfig(source)

Base configuration class for managing client-side connections in a remote communication setup.

This abstract class is designed to provide configuration settings required to establish a client connection, such as protocol, host, port, custom headers, and timeout options. It includes utility properties for constructing URL endpoints corresponding to specific functionalities like Server-Sent Events (SSE), health checks, and message handling.

Subclasses can extend this base configuration to implement more specific connection requirements or initialize predefined settings suitable for particular use cases.

Inheritors

DefaultClientConnectionConfig

Constructors

ClientConnectionConfig

constructor(host: String, port: Int? = null, protocol: URLProtocol? = null, headers: Map<String, List<String>>? = null, reconnectionDelay: Duration? = null, requestTimeout: Duration? = null, connectTimeout: Duration? = null)

Types

Companion

object Companion

Companion object for the ClientConnectionConfig class.

Properties

connectTimeout

val connectTimeout: Duration? = null

The timeout duration for establishing a connection, defaulting to null.

headers

val headers: Map<String, List<String>>

A collection of headers to be applied to HTTP requests made by the client.

healthCheckUrl

val healthCheckUrl: String

A computed property that constructs the URL endpoint for health check requests.

host

val host: String

The hostname or IP address of the target server to connect to.

jsonConfig

val jsonConfig: Json

Provides access to the current JSON serialization and deserialization configuration.

messageUrl

val messageUrl: String

Constructs the URL endpoint for sending or receiving messages.

port

val port: Int

The port number used for establishing a client connection.

protocol

val protocol: URLProtocol

The protocol used for the client connection.

reconnectionDelay

val reconnectionDelay: Duration? = null

The delay between attempts to reconnect, if applicable, defaulting to null.

requestTimeout

val requestTimeout: Duration? = null

The timeout duration for requests, defaulting to null.

sseUrl

val sseUrl: String

Constructs the URL endpoint for Server-Sent Events (SSE) communication.

url

val url: String

Provides the base URL for the current connection configuration. Constructs the URL using the protocol, host, and port specified in the connection configuration.

Functions

appendSerializersModule

fun appendSerializersModule(module: SerializersModule)

Appends the specified serializers module to the existing JSON configuration. This method allows dynamic addition of custom serialization and deserialization logic by merging the provided module with the current serializers module.