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
19	declare(strict_types=1);
20
21	namespace Ndrstmr\Icap;
22
23	use Ndrstmr\Icap\DTO\IcapRequest;
24
25	/**
26	* Formats ICAP requests into a sequence of raw byte chunks ready for
27	* transport.
28	*/
29	interface RequestFormatterInterface
30	{
31	/**
32	* Render the ICAP request into a sequence of raw byte chunks.
33	*
34	* Returning an iterable (instead of one large string) allows transports
35	* to stream large encapsulated HTTP bodies to the socket without
36	* buffering the whole request in memory.
37	*
38	* @return iterable<string>
39	*/
40	public function format(IcapRequest $request): iterable;
41	}