php-sdk/src/Server/Session/SessionInterface.php
Kyrian Obikwelu 719262b15d
feat(server): Rework transport architecture and add StreamableHttpTransport (#49)
* feat(server): Rework transport architecture and add StreamableHttpTransport

- `Server::connect()` no longer contains a processing loop.
- `TransportInterface` is updated with `setMessageHandler()` and `listen()`.
- `StdioTransport` is updated to implement the new interface.
- A new, minimal `StreamableHttpTransport` is added for stateless HTTP.

* refactor(server): use  event-driven message handling

* feat(server): Introduce a formal session management system

* fix: ensure session elements are preserved when building server (regression from #46)

* refactor: consolidate HTTP example to use shared dependencies

* feat(server): Enhance message handling with session support

- Updated `TransportInterface` to use `onMessage` for handling incoming messages with session IDs.
- Refactored `Server`, `Handler`, and transport classes to accommodate session management using `Uuid`.
- Introduced methods for creating sessions with auto-generated and specific UUIDs in `SessionFactory` and `SessionFactoryInterface`.

* feat(server): Integrate session management in message handling

- Added session support to the `Server` and `Handler` classes, allowing for session data to be managed during message processing.
- Updated `TransportInterface` to include session context in the `send` method.
- Refactored various request handlers to utilize session information, ensuring proper session handling for incoming requests.
- Introduced a file-based session store for persistent session data management

* feat: Update session builder method to use set* instead of with*

* feat: Fix test compatibility with new session management architecture

* chore: apply code style fixes

* fix: remove deprecated SSE transport and resolve PHPStan issues
2025-09-21 12:12:40 +02:00

85 lines
2 KiB
PHP

<?php
/*
* This file is part of the official PHP MCP SDK.
*
* A collaboration between Symfony and the PHP Foundation.
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Mcp\Server\Session;
use Symfony\Component\Uid\Uuid;
/**
* @author Kyrian Obikwelu <koshnawaza@gmail.com>
*/
interface SessionInterface extends \JsonSerializable
{
/**
* Get the session ID.
*/
public function getId(): Uuid;
/**
* Save the session.
*/
public function save(): void;
/**
* Get a specific attribute from the session.
* Supports dot notation for nested access.
*/
public function get(string $key, mixed $default = null): mixed;
/**
* Set a specific attribute in the session.
* Supports dot notation for nested access.
*/
public function set(string $key, mixed $value, bool $overwrite = true): void;
/**
* Check if an attribute exists in the session.
* Supports dot notation for nested access.
*/
public function has(string $key): bool;
/**
* Remove an attribute from the session.
* Supports dot notation for nested access.
*/
public function forget(string $key): void;
/**
* Remove all attributes from the session.
*/
public function clear(): void;
/**
* Get an attribute's value and then remove it from the session.
* Supports dot notation for nested access.
*/
public function pull(string $key, mixed $default = null): mixed;
/**
* Get all attributes of the session.
*
* @return array<string, mixed>
*/
public function all(): array;
/**
* Set all attributes of the session, typically for hydration.
* This will overwrite existing attributes.
*
* @param array<string, mixed> $attributes
*/
public function hydrate(array $attributes): void;
/**
* Get the session store instance.
*/
public function getStore(): SessionStoreInterface;
}