Arena  1.0
A content management system
 All Classes Files Functions Variables Pages
Library.IO.CGI.BufferedResponses.AnHTTPResponseBuffer Class Reference

This class can be used to buffer output from a CGI script. More...

+ Inheritance diagram for Library.IO.CGI.BufferedResponses.AnHTTPResponseBuffer:

Public Member Functions

def __init__
 Construct a new buffered output instance. More...
 
def init
 Initialize a new HTTP response buffer. More...
 
def __del__
 Destroy the HTTP response buffer. More...
 
def toString
 Return a string representation of the buffer. More...
 
- Public Member Functions inherited from Library.IO.StringStreams.AStringStream
def __init__
 Construct a new string stream instance. More...
 
def __del__
 Destroy the string stream instance. More...
 
def init
 Initialize a new string stream instance. More...
 
def close
 Close the stream.
 
def readFormat
 Read the specified values from the stream. More...
 
def writeFormat
 Write each value to the stream. More...
 
def read
 Read the specified values from the stream. More...
 
def write
 Write the specified values to the stream. More...
 
def readFrom
 Read the contents of the string stream from another stream. More...
 
def writeTo
 Write the contents of the string stream to another stream. More...
 
def toString
 Return a string representation of the stream. More...
 
def position
 Retrieve the current position within the stream. More...
 
def moveTo
 Set the current position within the stream. More...
 
def length
 Retrieve the current length of the stream. More...
 
- Public Member Functions inherited from Library.IO.Streams.AStream
def __init__
 Construct a new stream instance. More...
 
def init
 Initialize the stream instance. More...
 
def readFormat
 Read one or more values from the stream. More...
 
def writeFormat
 Write one or more values to the stream. More...
 
def read
 Read one or more values from the stream. More...
 
def write
 Write the specified values to the stream. More...
 
def writeString
 Write a string to the stream, including a length specifier. More...
 
def readString
 Read a string from the stream. More...
 
def rewindBy
 Rewind the stream by the specified number of bytes.
 
def position
 Return the current position within the stream. More...
 
def moveTo
 Set the current position within the stream. More...
 
def length
 Get the current length of the stream, in bytes. More...
 
def __len__
 Get the current length of the stream, in bytes. More...
 
def hasEnded
 Determine whether or not the end of the stream has been reached. More...
 
- Public Member Functions inherited from Library.Base.Classwork.AnObject
def init
 Initialize a new object instance. More...
 
def __init__
 Construct and initialize a new instance of AnObject. More...
 
def __del__
 Destroy the object instance. More...
 
def displayName
 Construct a "pretty" display name for the class instance, based on the name of its class. More...
 
def implements
 Determine whether the class instance is related to the specified class. More...
 
def toString
 Return a string representation of the class, suitable for output to a console or text-based device. More...
 
def __str__
 Return a string representation of the class. More...
 
def classname
 Return the name of the class from which the instance was created. More...
 
def name
 Return the name of the class. More...
 
- Public Member Functions inherited from Library.IO.Streams.IsStreamable
def writeTo
 Write class instance data to the specified stream. More...
 
def readFrom
 Read class instance data from the specified stream. More...
 

Detailed Description

This class can be used to buffer output from a CGI script.

It provides a few public attributes to make HTTP responses easy:

  • headers A dictionary of HTTP response headers that are written before the actual content of the response.
  • Cookie A dictionary of cookie values that are included as part of the HTTP response headers.

Constructor & Destructor Documentation

def Library.IO.CGI.BufferedResponses.AnHTTPResponseBuffer.__init__ (   Self,
  values 
)

Construct a new buffered output instance.

def Library.IO.CGI.BufferedResponses.AnHTTPResponseBuffer.__del__ (   Self)

Destroy the HTTP response buffer.

Member Function Documentation

def Library.IO.CGI.BufferedResponses.AnHTTPResponseBuffer.init (   Self)

Initialize a new HTTP response buffer.

The attributes of the instance are filled with their default values.

def Library.IO.CGI.BufferedResponses.AnHTTPResponseBuffer.toString (   Self)

Return a string representation of the buffer.

The string is formatted for presentation to an HTTP client. This means that it will first include the necessary HTTP headers, followed by a blank line and then the contents of the document itself.


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