AcpClient.SyncSpec

java.lang.Object
- com.agentclientprotocol.sdk.client.AcpClient.SyncSpec

封闭接口:

AcpClient
```
public static class AcpClient.SyncSpec
extends java.lang.Object
```
Synchronous client specification. This class follows the builder pattern to provide a fluent API for setting up synchronous clients with custom configurations.
The builder supports configuration of:
- Transport layer for client-agent communication
- Request timeouts for operation boundaries
- Client capabilities for feature negotiation
- Request handlers for incoming agent requests (file operations, etc.)
- Notification handlers for streaming updates

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`AcpSyncClient`	`build()` Creates an instance of `AcpSyncClient` with the provided configurations or sensible defaults.
`AcpClient.SyncSpec`	`clientCapabilities(AcpSchema.ClientCapabilities clientCapabilities)` Sets the client capabilities that will be advertised to the agent during initialization.
`AcpClient.SyncSpec`	`createTerminalHandler(java.util.function.Function<AcpSchema.CreateTerminalRequest,AcpSchema.CreateTerminalResponse> handler)` Adds a typed handler for terminal creation requests from the agent.
`AcpClient.SyncSpec`	`killTerminalHandler(java.util.function.Function<AcpSchema.KillTerminalCommandRequest,AcpSchema.KillTerminalCommandResponse> handler)` Adds a typed handler for terminal kill requests from the agent.
`AcpClient.SyncSpec`	`notificationHandler(java.lang.String method, AcpClientSession.NotificationHandler handler)` Adds a custom notification handler for a specific method.
`AcpClient.SyncSpec`	`readTextFileHandler(java.util.function.Function<AcpSchema.ReadTextFileRequest,AcpSchema.ReadTextFileResponse> handler)` Adds a typed handler for file system read requests from the agent.
`AcpClient.SyncSpec`	`releaseTerminalHandler(java.util.function.Function<AcpSchema.ReleaseTerminalRequest,AcpSchema.ReleaseTerminalResponse> handler)` Adds a typed handler for terminal release requests from the agent.
`<T> AcpClient.SyncSpec`	`requestHandler(java.lang.String method, AcpClient.SyncRequestHandler<T> handler)` Adds a synchronous custom request handler for a specific method.
`AcpClient.SyncSpec`	`requestPermissionHandler(java.util.function.Function<AcpSchema.RequestPermissionRequest,AcpSchema.RequestPermissionResponse> handler)` Adds a typed handler for permission requests from the agent.
`AcpClient.SyncSpec`	`requestTimeout(java.time.Duration requestTimeout)` Sets the duration to wait for agent responses before timing out requests.
`AcpClient.SyncSpec`	`sessionUpdateConsumer(java.util.function.Consumer<AcpSchema.SessionNotification> sessionUpdateConsumer)` Adds a synchronous consumer to be notified when session update notifications are received from the agent.
`AcpClient.SyncSpec`	`terminalOutputHandler(java.util.function.Function<AcpSchema.TerminalOutputRequest,AcpSchema.TerminalOutputResponse> handler)` Adds a typed handler for terminal output requests from the agent.
`AcpClient.SyncSpec`	`waitForTerminalExitHandler(java.util.function.Function<AcpSchema.WaitForTerminalExitRequest,AcpSchema.WaitForTerminalExitResponse> handler)` Adds a typed handler for wait-for-terminal-exit requests from the agent.
`AcpClient.SyncSpec`	`writeTextFileHandler(java.util.function.Function<AcpSchema.WriteTextFileRequest,AcpSchema.WriteTextFileResponse> handler)` Adds a typed handler for file system write requests from the agent.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 方法详细资料
  - requestTimeout
```
public AcpClient.SyncSpec requestTimeout(java.time.Duration requestTimeout)
```
    Sets the duration to wait for agent responses before timing out requests. This timeout applies to all requests made through the client, including initialize, prompt, and session operations.
    
    参数:
    
    requestTimeout - The duration to wait before timing out requests. Must not be null.
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if requestTimeout is null
  - clientCapabilities
```
public AcpClient.SyncSpec clientCapabilities(AcpSchema.ClientCapabilities clientCapabilities)
```
    Sets the client capabilities that will be advertised to the agent during initialization. Capabilities define what features the client supports, such as file system operations, terminal access, and authentication methods.
    
    参数:
    
    clientCapabilities - The client capabilities configuration. Must not be null.
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if clientCapabilities is null
  - readTextFileHandler
```
public AcpClient.SyncSpec readTextFileHandler(java.util.function.Function<AcpSchema.ReadTextFileRequest,AcpSchema.ReadTextFileResponse> handler)
```
    Adds a typed handler for file system read requests from the agent. Provides type-safe request handling with automatic unmarshalling.
    Example usage:
```
 .readTextFileHandler(req ->
     new ReadTextFileResponse(Files.readString(Path.of(req.path()))))
 
```
    参数:
    
    handler - The typed handler function that processes read requests
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if handler is null
  - writeTextFileHandler
```
public AcpClient.SyncSpec writeTextFileHandler(java.util.function.Function<AcpSchema.WriteTextFileRequest,AcpSchema.WriteTextFileResponse> handler)
```
    Adds a typed handler for file system write requests from the agent. Provides type-safe request handling with automatic unmarshalling.
    Example usage:
```
 .writeTextFileHandler(req -> {
     Files.writeString(Path.of(req.path()), req.content());
     return new WriteTextFileResponse();
 })
 
```
    参数:
    
    handler - The typed handler function that processes write requests
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if handler is null
  - requestPermissionHandler
```
public AcpClient.SyncSpec requestPermissionHandler(java.util.function.Function<AcpSchema.RequestPermissionRequest,AcpSchema.RequestPermissionResponse> handler)
```
    Adds a typed handler for permission requests from the agent. Provides type-safe request handling with automatic unmarshalling.
    Example usage:
```
 .requestPermissionHandler(req -> {
     System.out.println("Permission requested: " + req.toolCall().title());
     // Show UI or auto-approve
     return new RequestPermissionResponse(
         new RequestPermissionOutcome("approve", null));
 })
 
```
    参数:
    
    handler - The typed handler function that processes permission requests
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if handler is null
  - createTerminalHandler
```
public AcpClient.SyncSpec createTerminalHandler(java.util.function.Function<AcpSchema.CreateTerminalRequest,AcpSchema.CreateTerminalResponse> handler)
```
    Adds a typed handler for terminal creation requests from the agent.
    Example usage:
```
 .createTerminalHandler(req -> {
     String terminalId = UUID.randomUUID().toString();
     // Start process with req.command(), req.args(), req.cwd()
     return new CreateTerminalResponse(terminalId);
 })
 
```
    参数:
    
    handler - The typed handler function that processes terminal creation requests
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if handler is null
  - terminalOutputHandler
```
public AcpClient.SyncSpec terminalOutputHandler(java.util.function.Function<AcpSchema.TerminalOutputRequest,AcpSchema.TerminalOutputResponse> handler)
```
    Adds a typed handler for terminal output requests from the agent.
    Example usage:
```
 .terminalOutputHandler(req -> {
     String output = getTerminalOutput(req.terminalId());
     return new TerminalOutputResponse(output, false, null);
 })
 
```
    参数:
    
    handler - The typed handler function that processes terminal output requests
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if handler is null
  - releaseTerminalHandler
```
public AcpClient.SyncSpec releaseTerminalHandler(java.util.function.Function<AcpSchema.ReleaseTerminalRequest,AcpSchema.ReleaseTerminalResponse> handler)
```
    Adds a typed handler for terminal release requests from the agent.
    Example usage:
```
 .releaseTerminalHandler(req -> {
     releaseTerminal(req.terminalId());
     return new ReleaseTerminalResponse();
 })
 
```
    参数:
    
    handler - The typed handler function that processes terminal release requests
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if handler is null
  - waitForTerminalExitHandler
```
public AcpClient.SyncSpec waitForTerminalExitHandler(java.util.function.Function<AcpSchema.WaitForTerminalExitRequest,AcpSchema.WaitForTerminalExitResponse> handler)
```
    Adds a typed handler for wait-for-terminal-exit requests from the agent.
    Example usage:
```
 .waitForTerminalExitHandler(req -> {
     int exitCode = waitForExit(req.terminalId());
     return new WaitForTerminalExitResponse(exitCode, null);
 })
 
```
    参数:
    
    handler - The typed handler function that processes wait-for-exit requests
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if handler is null
  - killTerminalHandler
```
public AcpClient.SyncSpec killTerminalHandler(java.util.function.Function<AcpSchema.KillTerminalCommandRequest,AcpSchema.KillTerminalCommandResponse> handler)
```
    Adds a typed handler for terminal kill requests from the agent.
    Example usage:
```
 .killTerminalHandler(req -> {
     killProcess(req.terminalId());
     return new KillTerminalCommandResponse();
 })
 
```
    参数:
    
    handler - The typed handler function that processes terminal kill requests
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if handler is null
  - sessionUpdateConsumer
```
public AcpClient.SyncSpec sessionUpdateConsumer(java.util.function.Consumer<AcpSchema.SessionNotification> sessionUpdateConsumer)
```
    Adds a synchronous consumer to be notified when session update notifications are received from the agent. This is the preferred method for sync clients.
    Example usage:
```
 .sessionUpdateConsumer(notification -> {
     if (notification.update() instanceof AgentMessageChunk msg) {
         System.out.println(msg.content());
     }
 })
 
```
    参数:
    
    sessionUpdateConsumer - A consumer that receives session update notifications. Must not be null.
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if sessionUpdateConsumer is null
  - requestHandler
```
public <T> AcpClient.SyncSpec requestHandler(java.lang.String method,
                                             AcpClient.SyncRequestHandler<T> handler)
```
    Adds a synchronous custom request handler for a specific method. This is the preferred method for sync clients.
    
    类型参数:
    
    T - The response type
    
    参数:
    
    method - The method name (e.g., "custom/operation")
    
    handler - The synchronous handler function for this method
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if method or handler is null
  - notificationHandler
```
public AcpClient.SyncSpec notificationHandler(java.lang.String method,
                                              AcpClientSession.NotificationHandler handler)
```
    Adds a custom notification handler for a specific method. This allows handling additional agent notifications beyond session updates.
    
    参数:
    
    method - The method name (e.g., "custom/notification")
    
    handler - The handler function for this method
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if method or handler is null
  - build
```
public AcpSyncClient build()
```
    Creates an instance of AcpSyncClient with the provided configurations or sensible defaults.
    
    返回:
    
    a new instance of AcpSyncClient

类 AcpClient.SyncSpec

方法概要

从类继承的方法 java.lang.Object

方法详细资料

requestTimeout

clientCapabilities

readTextFileHandler

writeTextFileHandler

requestPermissionHandler

createTerminalHandler

terminalOutputHandler

releaseTerminalHandler

waitForTerminalExitHandler

killTerminalHandler

sessionUpdateConsumer

requestHandler

notificationHandler

build