Namespace: OpenEdge.Net.HTTP.Filter.Payload
Class
StringEntityWriter
Parent classes:
Progress.IO.OutputStream
OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
OpenEdge.Net.HTTP.Filter.Payload.StringEntityWriter

Inherits: OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Implements: OpenEdge.Net.ISupportEncoding

Copyright (c) 2015, 2018 by Progress Software Corporation. All rights reserved.
File:StringEntityWriter
Author(s):pjudge
Created:Thu Jan 29 10:47:13 EST 2015
Notes:- Write() operations are destructive (they replace the existing
Entity).
/* Content encoding (eg utf-8) used used by this writer




Method Summary
Options Name Purpose
Close () /** Closes the writer. */
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
LogMessage (character, integer) /** Logs a message. @param character The message to log @param integer The level this message should be logged at */
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
LogMessage (character, LogLevelEnum) /** Logs a message @param character The message to log @param LogLevelEnum The level this message should be logged at */
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Open () /** Opens the writer for output. Open/Close allows us to write the same message multiple times without requiring a new writer each time. */
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
INT64 Write (character) /** Write data to/from the message @param character Data to write */
Overrides OpenEdge.Net.HTTP.Filter.Payload.MessageWriter:Write (character)
INT64 Write (handle) /** Write data to/from the entity @param handle Data to write */
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
INT64 Write (longchar)
Overrides OpenEdge.Net.HTTP.Filter.Payload.MessageWriter:Write (longchar)
INT64 Write (memptr)
Overrides OpenEdge.Net.HTTP.Filter.Payload.MessageWriter:Write (memptr)
INT64 Write (memptr, int64, int64) /* no-op */
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
INT64 Write (Object)
Overrides OpenEdge.Net.HTTP.Filter.Payload.MessageWriter:Write (Object)
INT64 WriteFileStream (FileInputStream) /** Reads the contents of a file and writes the bytes as memptr @param FileInputStream A valid file stream @return int64 The number of bytes read. */
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter

Constructor Summary
Options Name Purpose
StringEntityWriter ()

Property Summary
Options Name Purpose
CHARACTER Encoding
Progress.Lang.Object Entity
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Progress.Lang.Class EntityType
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
ILogWriter Logger
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter


Method Detail
Top

PUBLIC Close ()
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Purpose: Closes the writer.
Top

PROTECTED LogMessage (character, integer)
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Purpose: Logs a message.
Parameters:
pcMessage CHARACTER
piLogLevel INTEGER
Top

PROTECTED LogMessage (character, LogLevelEnum)
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Purpose: Logs a message
Parameters:
pcMessage CHARACTER
poLogLevel LogLevelEnum
Top

PUBLIC Open ()
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
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

PUBLIC INT64 Write (character)
Overrides OpenEdge.Net.HTTP.Filter.Payload.MessageWriter:Write (character)
Purpose: Write data to/from the message
Parameters:
pcData CHARACTER
Returns INT64
Top

PUBLIC INT64 Write (handle)
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Purpose: Write data to/from the entity
Parameters:
phData HANDLE
Returns INT64
Top

PUBLIC INT64 Write (longchar)
Overrides OpenEdge.Net.HTTP.Filter.Payload.MessageWriter:Write (longchar)
Parameters:
pcData LONGCHAR
Returns INT64
Top

PUBLIC INT64 Write (memptr)
Overrides OpenEdge.Net.HTTP.Filter.Payload.MessageWriter:Write (memptr)
Parameters:
pmData OpenEdge.Core.Memptr
Returns INT64
Top

PUBLIC INT64 Write (memptr, int64, int64)
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
/* no-op
Parameters:
p0 OpenEdge.Core.Memptr
p1 INT64
p2 INT64
Returns INT64
Top

PUBLIC INT64 Write (Object)
Overrides OpenEdge.Net.HTTP.Filter.Payload.MessageWriter:Write (Object)
Parameters:
poData Progress.Lang.Object
Returns INT64
Top

PROTECTED INT64 WriteFileStream (FileInputStream)
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Purpose: Reads the contents of a file and writes the bytes as memptr
Parameters:
pStream FileInputStream
Returns INT64
int64 The number of bytes read.


Constructor Detail
Top

PUBLIC StringEntityWriter ()


Property Detail
Top

PUBLIC CHARACTER Encoding
Returns CHARACTER
Top

PUBLIC Progress.Lang.Object Entity
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Returns Progress.Lang.Object
Top

PUBLIC Progress.Lang.Class EntityType
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Returns Progress.Lang.Class
Top

PUBLIC ILogWriter Logger
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Returns ILogWriter


Copyright © 2020 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.2.0