Geeklog
[ class tree: Geeklog ] [ index: Geeklog ] [ all elements ]

Class: Swift_Transport_IoBuffer

Source Location: /system/vendor/swiftmailer/swiftmailer/lib/classes/Swift/Transport/IoBuffer.php

Interface Overview

Swift_InputByteStream
   |
   --Swift_Transport_IoBuffer

Buffers input and output to a resource.


Author(s):

  • Chris Corbyn

Constants

Methods


Inherited Methods

Class: Swift_InputByteStream

Swift_InputByteStream::bind()
Attach $is to this stream.
Swift_InputByteStream::commit()
For any bytes that are currently buffered inside the stream, force them off the buffer.
Swift_InputByteStream::flushBuffers()
Flush the contents of the stream (empty it) and set the internal pointer to the beginning.
Swift_InputByteStream::unbind()
Remove an already bound stream.
Swift_InputByteStream::write()
Writes $bytes to the end of the stream.

Class Details

[line 16]
Buffers input and output to a resource.



Tags:

author:  Chris Corbyn


[ Top ]


Class Methods


method initialize [line 31]

void initialize( $params)

Perform any initialization needed, using the given $params.

Parameters will vary depending upon the type of IoBuffer used.




Tags:

access:  public


Parameters:

array   $params  

[ Top ]

method readLine [line 66]

string readLine( int $sequence)

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.




Tags:

access:  public


Parameters:

int   $sequence   of last write to scan from

[ Top ]

method setParam [line 39]

void setParam( string $param, mixed $value)

Set an individual param on the buffer (e.g. switching to SSL).



Tags:

access:  public


Parameters:

string   $param  
mixed   $value  

[ Top ]

method setWriteTranslations [line 54]

void setWriteTranslations( $replacements)

Set an array of string replacements which should be made on data written to the buffer.

This could replace LF with CRLF for example.




Tags:

access:  public


Parameters:

string[]   $replacements  

[ Top ]

method terminate [line 44]

void terminate( )

Perform any shutdown logic needed.



Tags:

access:  public


[ Top ]


Class Constants

TYPE_PROCESS =  0x0010

[line 22]

A process buffer with I/O support


[ Top ]

TYPE_SOCKET =  0x0001

[line 19]

A socket buffer over TCP


[ Top ]



Documentation generated on Sun, 02 Oct 2016 07:51:04 +0000 by phpDocumentor 1.4.3