Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
n/a
0 / 0
n/a
0 / 0
CRAP
n/a
0 / 0
1<?php
2
3/**
4 * SPDX-License-Identifier: EUPL-1.2
5 *
6 * This file is part of icap-flow.
7 *
8 * Licensed under the EUPL, Version 1.2 only (the "Licence");
9 * you may not use this work except in compliance with the Licence.
10 * You may obtain a copy of the Licence at:
11 *
12 *     https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the Licence is distributed on an "AS IS" basis,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 */
18
19declare(strict_types=1);
20
21namespace Ndrstmr\Icap\Transport;
22
23use Amp\Cancellation;
24use Ndrstmr\Icap\Config;
25
26/**
27 * Optional capability surface for transports that can hand out a
28 * {@see TransportSession}. The default async transport
29 * ({@see AsyncAmpTransport}) implements both this and
30 * {@see TransportInterface}; the synchronous transport intentionally
31 * does not — sync is for CLI usage where strict RFC 3507 §4.5
32 * preview-continue isn't worth the added complexity.
33 *
34 * Callers (typically {@see \Ndrstmr\Icap\IcapClient}) check for this
35 * interface via `instanceof` before opting into multi-round flows.
36 */
37interface SessionAwareTransport extends TransportInterface
38{
39    /**
40     * Open a session against the host described by $config. The
41     * caller MUST eventually call {@see TransportSession::release()}
42     * or {@see TransportSession::close()} on the returned session.
43     */
44    public function openSession(Config $config, ?Cancellation $cancellation = null): TransportSession;
45}