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

Inherits: Progress.IO.OutputStream
ABSTRACT

Copyright (c) 2015 by Progress Software Corporation. All rights reserved.
File:MessageWriter
Purpose:Writes content into an object, like
a JsonObject or String or Memptr or ByteBucket
Author(s):pjudge
Created:Thu Jun 25 15:41:58 EDT 2015




Method Summary
Options Name Purpose
# Close () /** Closes the writer. */
LogMessage (character, integer) /** Logs a message @param character A message subtype to use @param character The message to log @param integer The level this message should be logged at */
# Open () /** Opens the writer for output. Open/Close allows us to write the same message multiple times without requiring a new writer each time. */
# INT64 Write (character)
# INT64 Write (handle) /** Write data to/from the entity @param handle Data to write */
# INT64 Write (longchar)
# INT64 Write (memptr)
# INT64 Write (memptr, int64, int64)
# A INT64 Write (Object) /** Write data to/from the entity @param Object Data to write */

Constructor Summary
Options Name Purpose
MessageWriter (Class) /** Default constructor. */
MessageWriter (Class, Object) /** Constructor. @param Class The type of the entity - pseudo-generics here. @param Object The 'real' entity being written */

Property Summary
Options Name Purpose
# Progress.Lang.Object Entity /** (mandatory) The message entity that's being written to. The values passed in to the Write() methods will be parsed/processed and written to this entity. */
# Progress.Lang.Class EntityType /** (mandatory) The type that the entity this writer can write to. */


Method Detail
Top

PROTECTED Close ()
Purpose: Closes the writer.
Top

LogMessage (character, integer)
Purpose: Logs a message
Parameters:
pcMessage CHARACTER
piLogLevel INTEGER
Top

PROTECTED 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

PROTECTED INT64 Write (character)
Parameters:
p0 CHARACTER
Returns INT64
Top

PROTECTED INT64 Write (handle)
Purpose: Write data to/from the entity
Parameters:
phData HANDLE
Returns INT64
Top

PROTECTED INT64 Write (longchar)
Parameters:
p0 LONGCHAR
Returns INT64
Top

PROTECTED INT64 Write (memptr)
Parameters:
p0 MEMPTR
Returns INT64
Top

PROTECTED INT64 Write (memptr, int64, int64)
Parameters:
p0 MEMPTR
p1 INT64
p2 INT64
Returns INT64
Top

PROTECTED INT64 Write (Object)
Purpose: Write data to/from the entity
Parameters:
poData Progress.Lang.Object
Returns INT64


Constructor Detail
Top

MessageWriter (Class)
Purpose: Default constructor.
Parameters:
poType Progress.Lang.Class
Top

MessageWriter (Class, Object)
Purpose: Constructor.
Parameters:
poType Progress.Lang.Class
poEntity Progress.Lang.Object


Property Detail
Top

PROTECTED Progress.Lang.Object Entity
Purpose: (mandatory) The message entity that's being written to. The values passed
in to the Write() methods will be parsed/processed and written to this entity.
Returns Progress.Lang.Object
Top

PROTECTED Progress.Lang.Class EntityType
Purpose: (mandatory) The type that the entity this writer can write to.
Returns Progress.Lang.Class


10.27.2015 12:36:42