Namespace: OpenEdge.Net.HTTP.Filter.Payload
Class
ClientSocketResponseWriter
Parent classes:
Inherits: Progress.Lang.Object
Implements: OpenEdge.Net.HTTP.IHttpMessageWriter

Copyright (c) 2015,2016 by Progress Software Corporation. All rights reserved.
File:ClientSocketResponseWriter
Purpose:Writes HTTP data received from socket into a response and
a message body object (byte bucket)
Author(s):pjudge
Created:Mon Jan 26 09:57:31 EST 2015




Method Summary
Options Name Purpose
Close () /** Closes the output. See Open() */
Flush () /** Flushes data to the output location. What data is flushed depends on the implementation */
Open () /** Opens the writer for output. Open/Close allows us to write the same message multiple times without requiring a new writer each time. */
Write (character) /** Write data to/from the message @param character Data to write */
Write (longchar) /** Write data to the output location @param longchar Data to write */
Write (handle) /** Write data to/from the message @param handle Data to write */
Write (IHttpRequest) /* Specialised writer method for requests @param IHttpRequest A request to write */
Write (memptr) /** Write data to the output location @param memptr Data to write */
Write (Object) /** Write data to the output location @param Object Data to write */
Write (SocketReadEventArgs) /* Specialised writer method for socket read args @param SocketReadEventArgs A socket read args to write */

Constructor Summary
Options Name Purpose
ClientSocketResponseWriter (IHttpResponse, ByteBucket)

Property Summary
Options Name Purpose
INTEGER CR /* magic numbers */
INTEGER LF
OpenEdge.Net.HTTP.IHttpMessage Message /** (mandatory) The message that's being written */
OpenEdge.Core.ByteBucket MessageBody /* the message body, passed-in */
OpenEdge.Net.HTTP.IHttpRequest Request /* helper variable for the request, to avoid constant casting */
OpenEdge.Net.HTTP.IHttpResponse Response /* helper variable for the response, to avoid constant casting */


Method Detail
Top

Close ()

Purpose: Closes the output. See Open()
Top

Flush ()

Purpose: Flushes data to the output location. What data is flushed depends on the implementation
Top

Open ()

Purpose: Opens the writer for output. Open/Close allows us to write the same message multiple
times without requiring a new writer each time.
Top

Write (character)

Purpose: Write data to/from the message
Parameters:
pcData CHARACTER
Top

Write (longchar)

Purpose: Write data to the output location
Parameters:
pcData LONGCHAR
Top

Write (handle)

Purpose: Write data to/from the message
Parameters:
phData HANDLE
Top

Write (IHttpRequest)

/* Specialised writer method for requests
Parameters:
poRequest OpenEdge.Net.HTTP.IHttpRequest
Top

Write (memptr)

Purpose: Write data to the output location
Parameters:
pmData OpenEdge.Core.Memptr
Top

Write (Object)

Purpose: Write data to the output location
Parameters:
poData Progress.Lang.Object
Top

Write (SocketReadEventArgs)

/* Specialised writer method for socket read args
Parameters:
poSocketArgs OpenEdge.Net.ServerConnection.SocketReadEventArgs


Constructor Detail
Top

ClientSocketResponseWriter (IHttpResponse, ByteBucket)

Parameters:
poMessage OpenEdge.Net.HTTP.IHttpResponse
poMessageBody OpenEdge.Core.ByteBucket


Property Detail
Top

INTEGER CR

/* magic numbers
Returns INTEGER
Top

INTEGER LF

Returns INTEGER
Top

OpenEdge.Net.HTTP.IHttpMessage Message

Purpose: (mandatory) The message that's being written
Returns OpenEdge.Net.HTTP.IHttpMessage
Top

OpenEdge.Core.ByteBucket MessageBody

/* the message body, passed-in
Returns OpenEdge.Core.ByteBucket
Top

OpenEdge.Net.HTTP.IHttpRequest Request

/* helper variable for the request, to avoid constant casting
Returns OpenEdge.Net.HTTP.IHttpRequest
Top

OpenEdge.Net.HTTP.IHttpResponse Response

/* helper variable for the response, to avoid constant casting
Returns OpenEdge.Net.HTTP.IHttpResponse


Copyright © 2017 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 11.7