-
Notifications
You must be signed in to change notification settings - Fork 7
Expand file tree
/
Copy pathmultiple-sessions.html
More file actions
411 lines (379 loc) · 19.9 KB
/
Copy pathmultiple-sessions.html
File metadata and controls
411 lines (379 loc) · 19.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia Site Renderer 2.0.0 from target/filtered-site/markdown/cookbook/multiple-sessions.md at 2026-04-26
| Rendered using Apache Maven Fluido Skin 2.1.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0" />
<title>Working with Multiple Sessions – GitHub Copilot SDK :: Java</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-2.1.0.min.css" />
<link rel="stylesheet" href="../css/site.css" />
<link rel="stylesheet" href="../css/print.css" media="print" />
<script src="../js/apache-maven-fluido-2.1.0.min.js"></script>
<style>.github-fork-ribbon:before { background-color: gray; }</style>
</head>
<body class="topBarEnabled">
<a class="github-fork-ribbon right-top" href="https://github.com/github/copilot-sdk-java" data-ribbon="Fork me on GitHub">Fork me on GitHub</a>
<header id="topbar" class="navbar navbar-fixed-top ">
<div class="navbar-inner">
<div class="container-fluid">
<a data-target=".nav-collapse" data-toggle="collapse" class="btn btn-navbar">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</a>
<a class="brand" href="../index.html">GitHub Copilot SDK for Java
</a>
<ul class="nav">
<li class="dropdown">
<a class="dropdown-toggle" data-toggle="dropdown">Overview <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="../index.html">Introduction</a></li>
<li><a href="../getting-started.html">Getting Started</a></li>
<li><a href="../setup.html">Setup</a></li>
<li><a href="../documentation.html">Documentation</a></li>
<li><a href="../mcp.html">MCP Servers</a></li>
<li><a href="../hooks.html">Session Hooks</a></li>
<li><a href="../advanced.html">Advanced Usage</a></li>
<li><a href="../apidocs/index.html">API Javadoc</a></li>
</ul>
</li>
<li class="dropdown">
<a class="dropdown-toggle" data-toggle="dropdown">Guides <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="../documentation.html#Basic_Usage">Basic Usage</a></li>
<li><a href="../documentation.html#Handling_Responses">Handling Responses</a></li>
<li><a href="../documentation.html#Streaming_Responses">Streaming</a></li>
<li><a href="../documentation.html#Choosing_a_Model">Choosing a Model</a></li>
<li><a href="../documentation.html#Session_Management">Session Management</a></li>
</ul>
</li>
<li class="dropdown">
<a class="dropdown-toggle" data-toggle="dropdown">Advanced <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="../advanced.html#Custom_Tools">Custom Tools</a></li>
<li><a href="../advanced.html#System_Messages">System Messages</a></li>
<li><a href="../advanced.html#File_Attachments">File Attachments</a></li>
<li><a href="../advanced.html#Bring_Your_Own_Key_.28BYOK.29">BYOK</a></li>
<li><a href="../advanced.html#Infinite_Sessions">Infinite Sessions</a></li>
<li><a href="../advanced.html#MCP_Servers">MCP Servers</a></li>
<li><a href="../advanced.html#Slash_Commands">Slash Commands</a></li>
<li><a href="../advanced.html#Elicitation_UI_Dialogs">Elicitation</a></li>
<li><a href="../advanced.html#Getting_Session_Metadata_by_ID">Session Metadata</a></li>
<li><a href="../hooks.html">Session Hooks</a></li>
</ul>
</li>
<li class="dropdown">
<a class="dropdown-toggle" data-toggle="dropdown">Cookbook <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="../cookbook/README.html">Overview</a></li>
<li><a href="../cookbook/error-handling.html">Error Handling</a></li>
<li><a>Multiple Sessions</a></li>
<li><a href="../cookbook/managing-local-files.html">Managing Local Files</a></li>
<li><a href="../cookbook/pr-visualization.html">PR Visualization</a></li>
<li><a href="../cookbook/persisting-sessions.html">Persisting Sessions</a></li>
</ul>
</li>
<li class="dropdown">
<a class="dropdown-toggle" data-toggle="dropdown">Project Documentation <b class="caret"></b></a>
<ul class="dropdown-menu">
<li class="dropdown-submenu">
<a href="../project-info.html">Project Information</a>
<ul class="dropdown-menu">
<li><a href="../dependencies.html">Dependencies</a></li>
<li><a href="../dependency-info.html">Maven Coordinates</a></li>
<li><a href="../distribution-management.html">Distribution Management</a></li>
<li><a href="../index.html">About</a></li>
<li><a href="../licenses.html">Licenses</a></li>
<li><a href="../plugin-management.html">Plugin Management</a></li>
<li><a href="../plugins.html">Plugins</a></li>
<li><a href="../scm.html">Source Code Management</a></li>
<li><a href="../summary.html">Summary</a></li>
<li><a href="../team.html">Team</a></li>
</ul>
</li>
<li class="dropdown-submenu">
<a href="../project-reports.html">Project Reports</a>
<ul class="dropdown-menu">
<li><a href="../apidocs/index.html">Javadoc</a></li>
<li><a href="../surefire.html">Surefire</a></li>
<li><a href="../spotbugs.html">SpotBugs</a></li>
<li><a href="../taglist.html">Tag List</a></li>
<li><a href="../dependency-analysis.html">Dependency Analysis</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</header>
<div class="container-fluid container-fluid-top">
<header>
<div id="banner">
<div class="pull-left"></div>
<div class="pull-right"></div>
<div class="clear"><hr/></div>
</div>
<div id="breadcrumbs">
<ul class="breadcrumb">
<li id="publishDate">Last Published: 2026-04-26<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 0.3.0-java.2<span class="divider">|</span></li>
<li><a href="../index.html">Home</a><span class="divider">/</span></li>
<li class="active">Working with Multiple Sessions</li>
</ul>
</div>
</header>
<div class="row-fluid">
<header id="leftColumn" class="span2">
<nav class="well sidebar-nav">
<ul class="nav nav-list">
<li class="nav-header">Overview</li>
<li><a href="../index.html">Introduction</a></li>
<li><a href="../getting-started.html">Getting Started</a></li>
<li><a href="../setup.html">Setup</a></li>
<li><a href="../documentation.html">Documentation</a></li>
<li><a href="../mcp.html">MCP Servers</a></li>
<li><a href="../hooks.html">Session Hooks</a></li>
<li><a href="../advanced.html">Advanced Usage</a></li>
<li><a href="../apidocs/index.html">API Javadoc</a></li>
<li class="nav-header">Guides</li>
<li><a href="../documentation.html#Basic_Usage">Basic Usage</a></li>
<li><a href="../documentation.html#Handling_Responses">Handling Responses</a></li>
<li><a href="../documentation.html#Streaming_Responses">Streaming</a></li>
<li><a href="../documentation.html#Choosing_a_Model">Choosing a Model</a></li>
<li><a href="../documentation.html#Session_Management">Session Management</a></li>
<li class="nav-header">Advanced</li>
<li><a href="../advanced.html#Custom_Tools">Custom Tools</a></li>
<li><a href="../advanced.html#System_Messages">System Messages</a></li>
<li><a href="../advanced.html#File_Attachments">File Attachments</a></li>
<li><a href="../advanced.html#Bring_Your_Own_Key_.28BYOK.29">BYOK</a></li>
<li><a href="../advanced.html#Infinite_Sessions">Infinite Sessions</a></li>
<li><a href="../advanced.html#MCP_Servers">MCP Servers</a></li>
<li><a href="../advanced.html#Slash_Commands">Slash Commands</a></li>
<li><a href="../advanced.html#Elicitation_UI_Dialogs">Elicitation</a></li>
<li><a href="../advanced.html#Getting_Session_Metadata_by_ID">Session Metadata</a></li>
<li><a href="../hooks.html">Session Hooks</a></li>
<li class="nav-header">Cookbook</li>
<li><a href="../cookbook/README.html">Overview</a></li>
<li><a href="../cookbook/error-handling.html">Error Handling</a></li>
<li class="active"><a>Multiple Sessions</a></li>
<li><a href="../cookbook/managing-local-files.html">Managing Local Files</a></li>
<li><a href="../cookbook/pr-visualization.html">PR Visualization</a></li>
<li><a href="../cookbook/persisting-sessions.html">Persisting Sessions</a></li>
<li class="nav-header">Project Documentation</li>
<li><a href="../project-info.html"><span class="icon-chevron-right"></span>Project Information</a></li>
<li><a href="../project-reports.html"><span class="icon-chevron-right"></span>Project Reports</a></li>
</ul>
</nav>
<div class="well sidebar-nav">
<div id="poweredBy">
<div class="clear"></div>
<div class="clear"></div>
<a href="https://maven.apache.org/" class="builtBy" target="_blank"><img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /></a>
</div>
</div>
</header>
<main id="bodyColumn" class="span10">
<section><a id="Working_with_Multiple_Sessions"></a>
<h1>Working with Multiple Sessions</h1>
<p>Manage multiple independent conversations simultaneously.</p><section><a id="Prerequisites"></a>
<h2>Prerequisites</h2>
<p>Install <a href="https://www.jbang.dev/" class="externalLink">JBang</a> to run these examples:</p>
<pre class="prettyprint"><code class="language-bash"># macOS (using Homebrew)
brew install jbangdev/tap/jbang
# Linux/macOS (using curl)
curl -Ls https://sh.jbang.dev | bash -s - app setup
# Windows (using Scoop)
scoop install jbang
</code></pre></section><section><a id="Example_scenario"></a>
<h2>Example scenario</h2>
<p>You need to run multiple conversations in parallel, each with its own context and history.</p></section><section><a id="Java"></a>
<h2>Java</h2>
<p><strong>Usage:</strong></p>
<pre class="prettyprint"><code class="language-bash">jbang MultipleSessions.java
</code></pre>
<p><strong>Code:</strong></p>
<pre class="prettyprint"><code class="language-java">//DEPS com.github:copilot-sdk-java:0.3.0-java.2
import com.github.copilot.sdk.CopilotClient;
import com.github.copilot.sdk.generated.AssistantMessageEvent;
import com.github.copilot.sdk.json.MessageOptions;
import com.github.copilot.sdk.json.PermissionHandler;
import com.github.copilot.sdk.json.SessionConfig;
public class MultipleSessions {
public static void main(String[] args) throws Exception {
try (var client = new CopilotClient()) {
client.start().get();
// Create multiple independent sessions
var session1 = client.createSession(
new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL).setModel("gpt-5")).get();
var session2 = client.createSession(
new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL).setModel("gpt-5")).get();
var session3 = client.createSession(
new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL).setModel("claude-sonnet-4.5")).get();
// Set up event handlers for each session
session1.on(AssistantMessageEvent.class, msg ->
System.out.println("Session 1: " + msg.getData().content()));
session2.on(AssistantMessageEvent.class, msg ->
System.out.println("Session 2: " + msg.getData().content()));
session3.on(AssistantMessageEvent.class, msg ->
System.out.println("Session 3: " + msg.getData().content()));
// Each session maintains its own conversation history
session1.send(new MessageOptions()
.setPrompt("You are helping with a Python project"));
session2.send(new MessageOptions()
.setPrompt("You are helping with a TypeScript project"));
session3.send(new MessageOptions()
.setPrompt("You are helping with a Go project"));
// Follow-up messages stay in their respective contexts
session1.send(new MessageOptions()
.setPrompt("How do I create a virtual environment?"));
session2.send(new MessageOptions()
.setPrompt("How do I set up tsconfig?"));
session3.send(new MessageOptions()
.setPrompt("How do I initialize a module?"));
// Wait for all sessions to complete
Thread.sleep(5000);
// Clean up
session1.close();
session2.close();
session3.close();
}
}
}
</code></pre></section><section><a id="Custom_session_IDs"></a>
<h2>Custom session IDs</h2>
<p>Use custom IDs for easier tracking:</p>
<pre class="prettyprint"><code class="language-java">var session = client.createSession(
new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)
.setSessionId("user-123-chat")
.setModel("gpt-5")
).get();
System.out.println(session.getSessionId()); // "user-123-chat"
</code></pre></section><section><a id="Listing_sessions"></a>
<h2>Listing sessions</h2>
<pre class="prettyprint"><code class="language-java">var sessions = client.listSessions().get();
for (var sessionInfo : sessions) {
System.out.println("Session: " + sessionInfo.getSessionId());
}
</code></pre></section><section><a id="Deleting_sessions"></a>
<h2>Deleting sessions</h2>
<pre class="prettyprint"><code class="language-java">// Delete a specific session
try {
client.deleteSession("user-123-chat").get();
} catch (Exception ex) {
System.err.println("Failed to delete session: " + ex.getMessage());
}
</code></pre></section><section><a id="Managing_session_lifecycle_with_CompletableFuture"></a>
<h2>Managing session lifecycle with CompletableFuture</h2>
<pre class="prettyprint"><code class="language-java">//DEPS com.github:copilot-sdk-java:0.3.0-java.2
import java.util.concurrent.CompletableFuture;
import java.util.List;
public class ParallelSessions {
public static void runParallelSessions(CopilotClient client) throws Exception {
// Create sessions in parallel
var sessionFutures = List.of(
client.createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL).setModel("gpt-5")),
client.createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL).setModel("gpt-5")),
client.createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL).setModel("claude-sonnet-4.5"))
);
// Wait for all sessions to be created
CompletableFuture.allOf(sessionFutures.toArray(new CompletableFuture[0]))
.get();
// Get the created sessions
var session1 = sessionFutures.get(0).get();
var session2 = sessionFutures.get(1).get();
var session3 = sessionFutures.get(2).get();
// Send messages in parallel
var messageFutures = List.of(
session1.sendAndWait(new MessageOptions().setPrompt("Question 1")),
session2.sendAndWait(new MessageOptions().setPrompt("Question 2")),
session3.sendAndWait(new MessageOptions().setPrompt("Question 3"))
);
// Wait for all responses
CompletableFuture.allOf(messageFutures.toArray(new CompletableFuture[0]))
.get();
// Clean up
session1.close();
session2.close();
session3.close();
}
}
</code></pre></section><section><a id="Providing_a_custom_Executor_for_parallel_sessions"></a>
<h2>Providing a custom Executor for parallel sessions</h2>
<p>By default, <code>CompletableFuture</code> operations run on <code>ForkJoinPool.commonPool()</code>,
which has limited parallelism (typically <code>Runtime.availableProcessors() - 1</code>
threads). When multiple sessions block waiting for CLI responses, those threads
are unavailable for other work—a condition known as <em>pool starvation</em>.</p>
<p>Use <code>CopilotClientOptions.setExecutor(Executor)</code> to supply a dedicated thread
pool so that SDK work does not compete with the rest of your application for
common-pool threads:</p>
<pre class="prettyprint"><code class="language-java">//DEPS com.github:copilot-sdk-java:0.3.0-java.2
import com.github.copilot.sdk.CopilotClient;
import com.github.copilot.sdk.json.CopilotClientOptions;
import com.github.copilot.sdk.json.SessionConfig;
import com.github.copilot.sdk.json.MessageOptions;
import com.github.copilot.sdk.json.PermissionHandler;
import java.util.List;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
public class ParallelSessionsWithExecutor {
public static void main(String[] args) throws Exception {
ExecutorService pool = Executors.newFixedThreadPool(4);
try {
var options = new CopilotClientOptions().setExecutor(pool);
try (CopilotClient client = new CopilotClient(options)) {
client.start().get();
var s1 = client.createSession(new SessionConfig()
.setOnPermissionRequest(PermissionHandler.APPROVE_ALL)
.setModel("gpt-5")).get();
var s2 = client.createSession(new SessionConfig()
.setOnPermissionRequest(PermissionHandler.APPROVE_ALL)
.setModel("gpt-5")).get();
var s3 = client.createSession(new SessionConfig()
.setOnPermissionRequest(PermissionHandler.APPROVE_ALL)
.setModel("claude-sonnet-4.5")).get();
CompletableFuture.allOf(
s1.sendAndWait(new MessageOptions().setPrompt("Question 1")),
s2.sendAndWait(new MessageOptions().setPrompt("Question 2")),
s3.sendAndWait(new MessageOptions().setPrompt("Question 3"))
).get();
s1.close();
s2.close();
s3.close();
}
} finally {
pool.shutdown();
}
}
}
</code></pre>
<p>Passing <code>null</code> (or omitting <code>setExecutor</code> entirely) keeps the default
<code>ForkJoinPool.commonPool()</code> behaviour. The executor is used for all internal
<code>CompletableFuture.runAsync</code> / <code>supplyAsync</code> calls—including client start/stop,
tool-call dispatch, permission dispatch, user-input dispatch, and hooks.</p></section><section><a id="Use_cases"></a>
<h2>Use cases</h2>
<ul>
<li><strong>Multi-user applications</strong>: One session per user</li>
<li><strong>Multi-task workflows</strong>: Separate sessions for different tasks</li>
<li><strong>A/B testing</strong>: Compare responses from different models</li>
<li><strong>Parallel processing</strong>: Process multiple requests simultaneously</li>
</ul></section></section> </main>
</div>
</div>
<hr/>
<footer>
<div class="container-fluid">
<div class="row-fluid">
<p>© 2026
</p>
</div>
</div>
</footer>
</body>
</html>