Namespace: OpenEdge.Web
Class
WebResponseWriter
Parent classes:
Progress.IO.OutputStream
OpenEdge.Web.WebResponseWriter

Inherits: Progress.IO.OutputStream

Copyright (c) 2015-2016, 2020-2021 by Progress Software Corporation. All rights reserved.
Purpose:Writes data to a (web) stream from either a repsonse object
or from "Write" calls made by a caller.
Author(s):mbanks
Created:Mon Feb 02 11:54:49 EST 2015
@since:11.6




Method Summary
Options Name Purpose
Close () /* Closes the web stream */
OpenEdge.Core.ByteBucket ExtractEntity () /* Converts the response Entity into a set of bytes for returning to the client @return ByteBucket A container for the message body */
Flush () /* Flushes the contents to the web stream */
Open () /* Opens the web stream */
INT64 Write (character) /* Writes character data to the web stream @param character The data to write to the web stream @return int64 The number of bytes written */
INT64 Write (longchar) /* Writes character data to the web stream @param longchar The data to write to the web stream @return int64 The number of bytes written */
INT64 Write (memptr) /* Writes a complete memptr to the web stream @param memptr A chunk of data as a memptr @return int64 The number of bytes written */
INT64 Write (memptr, int64, int64) /* Writes some bytes from a memptr to the web stream @param memptr The entire memptr @param int64 The offset (start byte) @param int64 The number of bytes to write from the offset @return int64 The number of bytes written */
WriteBody () /* Dumps a complete response to the output stream. */
WriteCookies () /* Writes all cookies into the web stream */
WriteHeader (character, character) /* Helper method to write message headers into the http message @param character The header name @param character The header value */
WriteHeaders () /* Writes all headers */
WriteHttpPreamble () /* Writes out the HTTP status line & headers. If the response's ContentLength has been set and there's no Entity/body, then we may be dealing with a response to a HEAD request, in which case respect the previously-set value, and send back the value. Otherwise used Transfer-Encoding: chunked */
WriteStatusLine () /* Writes the status line */

Constructor Summary
Options Name Purpose
WebResponseWriter () /* Default Constructor */
WebResponseWriter (IHttpResponse) /* Constructor @param IHttpResponse The response being written */

Property Summary
Options Name Purpose
OpenEdge.Net.HTTP.IHttpMessage Message
OpenEdge.Net.HTTP.IHttpResponse Response
HANDLE WebStream


Method Detail
Top

Close ()
/* Closes the web stream
Top

OpenEdge.Core.ByteBucket ExtractEntity ()
/* Converts the response Entity into a set of bytes for returning to the client
Returns OpenEdge.Core.ByteBucket
ByteBucket A container for the message body
Top

Flush ()
/* Flushes the contents to the web stream
Top

Open ()
/* Opens the web stream
Top

INT64 Write (character)
/* Writes character data to the web stream
Parameters:
pcData CHARACTER
Returns INT64
int64 The number of bytes written
Top

INT64 Write (longchar)
/* Writes character data to the web stream
Parameters:
lcData LONGCHAR
Returns INT64
int64 The number of bytes written
Top

INT64 Write (memptr)
/* Writes a complete memptr to the web stream
Parameters:
pData MEMPTR
Returns INT64
int64 The number of bytes written
Top

INT64 Write (memptr, int64, int64)
/* Writes some bytes from a memptr to the web stream
Parameters:
pmData MEMPTR
offset INT64
len INT64
Returns INT64
int64 The number of bytes written
Top

WriteBody ()
/* Dumps a complete response to the output stream.
Top

WriteCookies ()
/* Writes all cookies into the web stream
Top

WriteHeader (character, character)
/* Helper method to write message headers into the http message
Parameters:
pcName CHARACTER
pcValue CHARACTER
Top

WriteHeaders ()
/* Writes all headers
Top

WriteHttpPreamble ()
/* Writes out the HTTP status line & headers.
If the response's ContentLength has been set and there's no Entity/body, then
we may be dealing with a response to a HEAD request, in which case respect the
previously-set value, and send back the value.
Otherwise used Transfer-Encoding: chunked
Top

WriteStatusLine ()
/* Writes the status line


Constructor Detail
Top

WebResponseWriter ()
/* Default Constructor
Top

WebResponseWriter (IHttpResponse)
/* Constructor
Parameters:
poResponse OpenEdge.Net.HTTP.IHttpResponse


Property Detail
Top

OpenEdge.Net.HTTP.IHttpMessage Message
Returns OpenEdge.Net.HTTP.IHttpMessage
Top

OpenEdge.Net.HTTP.IHttpResponse Response
Returns OpenEdge.Net.HTTP.IHttpResponse
Top

HANDLE WebStream
Returns HANDLE


Copyright © 2022 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.6.0