76 lines
2.1 KiB
PHP
76 lines
2.1 KiB
PHP
<?php
|
|
|
|
/*
|
|
Input-output buffer interface from Swift Mailer.
|
|
|
|
This program is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
*/
|
|
|
|
//@require 'Swift/InputByteStream.php';
|
|
//@require 'Swift/OutputByteStream.php';
|
|
|
|
/**
|
|
* Buffers input and output to a resource.
|
|
* @package Swift
|
|
* @subpackage Transport
|
|
* @author Chris Corbyn
|
|
*/
|
|
interface Swift_Transport_IoBuffer
|
|
extends Swift_InputByteStream, Swift_OutputByteStream
|
|
{
|
|
|
|
/** A socket buffer over TCP */
|
|
const TYPE_SOCKET = 0x0001;
|
|
|
|
/** A process buffer with I/O support */
|
|
const TYPE_PROCESS = 0x0010;
|
|
|
|
/**
|
|
* Perform any initialization needed, using the given $params.
|
|
* Parameters will vary depending upon the type of IoBuffer used.
|
|
* @param array $params
|
|
*/
|
|
public function initialize(array $params);
|
|
|
|
/**
|
|
* Set an individual param on the buffer (e.g. switching to SSL).
|
|
* @param string $param
|
|
* @param mixed $value
|
|
*/
|
|
public function setParam($param, $value);
|
|
|
|
/**
|
|
* Perform any shutdown logic needed.
|
|
*/
|
|
public function terminate();
|
|
|
|
/**
|
|
* Set an array of string replacements which should be made on data written
|
|
* to the buffer. This could replace LF with CRLF for example.
|
|
* @param string[] $replacements
|
|
*/
|
|
public function setWriteTranslations(array $replacements);
|
|
|
|
/**
|
|
* Get a line of output (including any CRLF).
|
|
* The $sequence number comes from any writes and may or may not be used
|
|
* depending upon the implementation.
|
|
* @param int $sequence of last write to scan from
|
|
* @return string
|
|
*/
|
|
public function readLine($sequence);
|
|
|
|
}
|