| 1: | <?php |
| 2: | |
| 3: | declare(strict_types=1); |
| 4: | |
| 5: | /** |
| 6: | * This file is part of the Nexus MCP SDK package. |
| 7: | * |
| 8: | * (c) 2026 John Paul E. Balandan, CPA <paulbalandan@gmail.com> |
| 9: | * |
| 10: | * For the full copyright and license information, please view |
| 11: | * the LICENSE file that was distributed with this source code. |
| 12: | */ |
| 13: | |
| 14: | namespace Nexus\Mcp\Core\Dispatch; |
| 15: | |
| 16: | use Nexus\Mcp\Core\Schema\RequestId; |
| 17: | use Nexus\Mcp\Core\Transport\ReceiveContext; |
| 18: | use Nexus\Mcp\Core\Transport\TransportInterface; |
| 19: | |
| 20: | /** |
| 21: | * Per-envelope inbound dispatch contract shared by the Server and Client |
| 22: | * runtimes. Each side owns one implementation and exposes it to a |
| 23: | * transport's `onMessage` / `onDrain` listeners. |
| 24: | */ |
| 25: | interface MessageDispatcherInterface |
| 26: | { |
| 27: | /** |
| 28: | * Processes a single inbound JSON-RPC envelope. |
| 29: | * |
| 30: | * @param array<string, mixed> $envelope |
| 31: | */ |
| 32: | public function dispatch(array $envelope, TransportInterface $transport, ReceiveContext $context): void; |
| 33: | |
| 34: | /** |
| 35: | * Awaits every in-flight dispatch coroutine spawned by `dispatch()`. |
| 36: | */ |
| 37: | public function flushPending(): void; |
| 38: | |
| 39: | /** |
| 40: | * Cancels the in-flight request `$id` names, if one is still running under it. |
| 41: | */ |
| 42: | public function cancelRequest(RequestId $id): void; |
| 43: | } |
| 44: |