Big Sister Web Application Framework
List of all members
BigSWAF::TieBuffer Class Reference

Tie a buffer to an IO handle. More...

Public Class Methods

retval TIEHANDLE (scalar class, scalar buffer)

Public Object Methods

retval buffer (scalar buffer)
 Get/set the buffer contents.
retval TELL ()
retval SEEK (scalar where, scalar whence)
 Sets the current read/write position.
retval WRITE ()
 Write some contents into the buffer.
retval READ (undef, scalar len, scalar offset)
 Reads some content from the buffer.
retval READLINE ()
 Reads a line from the buffer.

Detailed Description

Tie a buffer to an IO handle.

Read operations will read from a given buffer, write operations write into an in-memory buffer.

Member Function Documentation

retval BigSWAF::TieBuffer::buffer ( scalar  buffer)

Get/set the buffer contents.

If called with a buffer (string) as an argument the buffer for future read operations is set to the given string. If called without a parameter the current contents of the buffer is returned.

Parameters
buffer(optional) buffer contents
Returns
current buffer contents
retval BigSWAF::TieBuffer::READ ( undef  ,
scalar  len,
scalar  offset 
)

Reads some content from the buffer.

retval BigSWAF::TieBuffer::READLINE ( )

Reads a line from the buffer.

retval BigSWAF::TieBuffer::SEEK ( scalar  where,
scalar  whence 
)

Sets the current read/write position.

Parameters are like for seek().

retval BigSWAF::TieBuffer::TELL ( )
Returns
the current read/write position
retval BigSWAF::TieBuffer::TIEHANDLE ( scalar  class,
scalar  buffer 
)
retval BigSWAF::TieBuffer::WRITE ( )

Write some contents into the buffer.


The documentation for this class was generated from the following file: