[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /*
   4   * This file is part of SwiftMailer.
   5   * (c) 2004-2009 Chris Corbyn
   6   *
   7   * For the full copyright and license information, please view the LICENSE
   8   * file that was distributed with this source code.
   9   */
  10  
  11  /**
  12   * Buffers input and output to a resource.
  13   *
  14   * @author Chris Corbyn
  15   */
  16  interface Swift_Transport_IoBuffer extends Swift_InputByteStream, Swift_OutputByteStream
  17  {
  18      /** A socket buffer over TCP */
  19      const TYPE_SOCKET = 0x0001;
  20  
  21      /** A process buffer with I/O support */
  22      const TYPE_PROCESS = 0x0010;
  23  
  24      /**
  25       * Perform any initialization needed, using the given $params.
  26       *
  27       * Parameters will vary depending upon the type of IoBuffer used.
  28       */
  29      public function initialize(array $params);
  30  
  31      /**
  32       * Set an individual param on the buffer (e.g. switching to SSL).
  33       *
  34       * @param string $param
  35       * @param mixed  $value
  36       */
  37      public function setParam($param, $value);
  38  
  39      /**
  40       * Perform any shutdown logic needed.
  41       */
  42      public function terminate();
  43  
  44      /**
  45       * Set an array of string replacements which should be made on data written
  46       * to the buffer.
  47       *
  48       * This could replace LF with CRLF for example.
  49       *
  50       * @param string[] $replacements
  51       */
  52      public function setWriteTranslations(array $replacements);
  53  
  54      /**
  55       * Get a line of output (including any CRLF).
  56       *
  57       * The $sequence number comes from any writes and may or may not be used
  58       * depending upon the implementation.
  59       *
  60       * @param int $sequence of last write to scan from
  61       *
  62       * @return string
  63       */
  64      public function readLine($sequence);
  65  }