kotlin-sdk/docs/-m-c-p -kotlin -s-d-k/io.modelcontextprotocol.kotlin.sdk.server/-s-s-e-server-transport/index.html
Leonid Stashevsky 215effb7d6
Update package name across the project (#2)
* Change package name

* Update publication

* Update docs

* Update settings.gradle.kts, README and CONTRIBUTING

* Cleanup leftovers
2024-12-17 07:28:51 +01:00

254 lines
No EOL
22 KiB
HTML

<!DOCTYPE html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>SSEServerTransport</title>
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
<script>var pathToRoot = "../../../";</script>
<script>document.documentElement.classList.replace("no-js","js");</script>
<script>const storage = localStorage.getItem("dokka-dark-mode")
if (storage == null) {
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
<link href="../../../styles/style.css" rel="Stylesheet">
<link href="../../../styles/main.css" rel="Stylesheet">
<link href="../../../styles/prism.css" rel="Stylesheet">
<link href="../../../styles/logo-styles.css" rel="Stylesheet">
<link href="../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
<link href="../../../ui-kit/ui-kit.min.css" rel="Stylesheet">
<script type="text/javascript" src="../../../scripts/clipboard.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/navigation-loader.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/platform-content-handler.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/main.js" defer="defer"></script>
<script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
<script type="text/javascript" src="../../../ui-kit/ui-kit.min.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="root">
<nav class="navigation" id="navigation-wrapper">
<div class="navigation--inner">
<div class="navigation-title">
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
MCP Kotlin SDK
</a>
</div>
<div class="library-version">
0.1.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":/main">jvm</button>
</div>
</div>
<div class="navigation-controls">
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
</div>
</nav>
<div id="container">
<div class="sidebar" id="leftColumn">
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="classlike" id="content" pageIds="MCP Kotlin SDK::io.modelcontextprotocol.kotlin.sdk.server/SSEServerTransport///PointingToDeclaration//-251573632">
<div class="breadcrumbs"><a href="../../../index.html">MCP Kotlin SDK</a><span class="delimiter">/</span><a href="../index.html">io.modelcontextprotocol.kotlin.sdk.server</a><span class="delimiter">/</span><span class="current">SSEServerTransport</span></div>
<div class="cover ">
<h1 class="cover"><span>SSEServer</span><wbr></wbr><span><span>Transport</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":/main"><div class="symbol monospace"><span class="token keyword">class </span><a href="index.html">SSEServerTransport</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">endpoint<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">session<span class="token operator">: </span><span data-unresolved-link="io.ktor.server.sse/ServerSSESession///PointingToDeclaration/">ServerSSESession</span></span></span><span class="token punctuation">)</span> : <a href="../../io.modelcontextprotocol.kotlin.sdk.shared/-transport/index.html">Transport</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/modelcontextprotocol/kotlin-sdk/io/modelcontextprotocol/kotlin/sdk/server/SSEServerTransport.kt#L24">source</a>)</span></span></div><p class="paragraph">Server transport for SSE: this will send messages over an SSE connection and receive messages from HTTP POST requests.</p><p class="paragraph">Creates a new SSE server transport, which will direct the client to POST messages to the relative or absolute URL identified by <code class="lang-kotlin">_endpoint</code>.</p></div></div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
<div class="tabs-section-body">
<div data-togglable="CONSTRUCTOR">
<h2 class="">Constructors</h2>
<div class="table"><a data-name="175432280%2FConstructors%2F-251573632" anchor-label="SSEServerTransport" id="175432280%2FConstructors%2F-251573632" data-filterable-set=":/main"></a>
<div class="table-row" data-togglable="CONSTRUCTOR" data-filterable-current=":/main" data-filterable-set=":/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-s-s-e-server-transport.html"><span>SSEServer</span><wbr></wbr><span><span>Transport</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="175432280%2FConstructors%2F-251573632"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":/main"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">endpoint<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">session<span class="token operator">: </span><span data-unresolved-link="io.ktor.server.sse/ServerSSESession///PointingToDeclaration/">ServerSSESession</span></span></span><span class="token punctuation">)</span></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div data-togglable="PROPERTY">
<h2 class="">Properties</h2>
<div class="table"><a data-name="1770159903%2FProperties%2F-251573632" anchor-label="onClose" id="1770159903%2FProperties%2F-251573632" data-filterable-set=":/main"></a>
<div class="table-row" data-filterable-current=":/main" data-filterable-set=":/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="on-close.html"><span>on</span><wbr></wbr><span><span>Close</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1770159903%2FProperties%2F-251573632"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">var </span><a href="on-close.html">onClose</a><span class="token operator">: </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator">?</span></div><div class="brief "><p class="paragraph">Callback for when the connection is closed for any reason.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1743994127%2FProperties%2F-251573632" anchor-label="onError" id="1743994127%2FProperties%2F-251573632" data-filterable-set=":/main"></a>
<div class="table-row" data-filterable-current=":/main" data-filterable-set=":/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="on-error.html"><span>on</span><wbr></wbr><span><span>Error</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1743994127%2FProperties%2F-251573632"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">var </span><a href="on-error.html">onError</a><span class="token operator">: </span><span class="token punctuation">(</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html">Throwable</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator">?</span></div><div class="brief "><p class="paragraph">Callback for when an error occurs.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-209171088%2FProperties%2F-251573632" anchor-label="onMessage" id="-209171088%2FProperties%2F-251573632" data-filterable-set=":/main"></a>
<div class="table-row" data-filterable-current=":/main" data-filterable-set=":/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="on-message.html"><span>on</span><wbr></wbr><span><span>Message</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-209171088%2FProperties%2F-251573632"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">var </span><a href="on-message.html">onMessage</a><span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><a href="../../io.modelcontextprotocol.kotlin.sdk/-j-s-o-n-r-p-c-message/index.html">JSONRPCMessage</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator">?</span></div><div class="brief "><p class="paragraph">Callback for when a message (request or response) is received over the connection.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1399062425%2FProperties%2F-251573632" anchor-label="sessionId" id="-1399062425%2FProperties%2F-251573632" data-filterable-set=":/main"></a>
<div class="table-row" data-filterable-current=":/main" data-filterable-set=":/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="session-id.html"><span>session</span><wbr></wbr><span><span>Id</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1399062425%2FProperties%2F-251573632"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":/main"><div class="symbol monospace"><span class="token keyword">val </span><a href="session-id.html">sessionId</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div data-togglable="FUNCTION">
<h2 class="">Functions</h2>
<div class="table"><a data-name="1837473824%2FFunctions%2F-251573632" anchor-label="close" id="1837473824%2FFunctions%2F-251573632" data-filterable-set=":/main"></a>
<div class="table-row" data-filterable-current=":/main" data-filterable-set=":/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="close.html"><span><span>close</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1837473824%2FFunctions%2F-251573632"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">suspend override </span><span class="token keyword">fun </span><a href="close.html"><span class="token function">close</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Closes the connection.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="163680619%2FFunctions%2F-251573632" anchor-label="handleMessage" id="163680619%2FFunctions%2F-251573632" data-filterable-set=":/main"></a>
<div class="table-row" data-filterable-current=":/main" data-filterable-set=":/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="handle-message.html"><span>handle</span><wbr></wbr><span><span>Message</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="163680619%2FFunctions%2F-251573632"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":/main"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="handle-message.html"><span class="token function">handleMessage</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">message<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Handle a client message, regardless of how it arrived. This can be used to inform the server of messages that arrive via a means different from HTTP POST.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-323666854%2FFunctions%2F-251573632" anchor-label="handlePostMessage" id="-323666854%2FFunctions%2F-251573632" data-filterable-set=":/main"></a>
<div class="table-row" data-filterable-current=":/main" data-filterable-set=":/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="handle-post-message.html"><span>handle</span><wbr></wbr><span>Post</span><wbr></wbr><span><span>Message</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-323666854%2FFunctions%2F-251573632"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":/main"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="handle-post-message.html"><span class="token function">handlePostMessage</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">call<span class="token operator">: </span><span data-unresolved-link="io.ktor.server.application/ApplicationCall///PointingToDeclaration/">ApplicationCall</span></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Handles incoming POST messages.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1964691173%2FFunctions%2F-251573632" anchor-label="send" id="1964691173%2FFunctions%2F-251573632" data-filterable-set=":/main"></a>
<div class="table-row" data-filterable-current=":/main" data-filterable-set=":/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="send.html"><span><span>send</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1964691173%2FFunctions%2F-251573632"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">suspend override </span><span class="token keyword">fun </span><a href="send.html"><span class="token function">send</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">message<span class="token operator">: </span><a href="../../io.modelcontextprotocol.kotlin.sdk/-j-s-o-n-r-p-c-message/index.html">JSONRPCMessage</a></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Sends a JSON-RPC message (request or response).</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="2043405558%2FFunctions%2F-251573632" anchor-label="start" id="2043405558%2FFunctions%2F-251573632" data-filterable-set=":/main"></a>
<div class="table-row" data-filterable-current=":/main" data-filterable-set=":/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="start.html"><span><span>start</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2043405558%2FFunctions%2F-251573632"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">suspend override </span><span class="token keyword">fun </span><a href="start.html"><span class="token function">start</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Handles the initial SSE connection request.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<a href="#content" id="go-to-top-link" class="footer--button footer--button_go-to-top"></a>
<span>© 2024 Copyright</span>
<span class="pull-right">
<span>Generated by </span>
<a class="footer--link footer--link_external" href="https://github.com/Kotlin/dokka">
<span>dokka</span>
</a>
</span>
</div>
</div>
</div>
</div>
</body>
</html>