Namespace: OpenEdge.Net.HTTP.Lib.ABLSockets
Class 
ABLSocketLibrary
Parent classes:
Progress.Lang.Object
OpenEdge.Net.HTTP.Lib.ABLSockets.ABLSocketLibrary

Inherits: Progress.Lang.Object
Implements: OpenEdge.Net.HTTP.IHttpClientLibrary, OpenEdge.Core.ISupportInitialize

Copyright (c) 2014, 2015 by Progress Software Corporation. All rights reserved.
File:ABLSocketLibrary
Author(s):pjudge
Created:Mon Jan 20 09:46:05 EST 2014




Method Summary
Options Name Purpose
# DataReceivedHandler (ClientSocket, SocketReadEventArgs) /** Event handler for dealing with data received from the ClientSocket @param ClientSocket The socket object receiving the response @param SocketReadEventArgs Arguments pertaining to the data received */
# Destroy ()
# Execute (IHttpRequest, IHttpResponse) /** Executes an HTTP request, and returns a response @param HttpRequest The request to execute @param HttpResponse The response from the server for that request. */
+ ExtractBody (IHttpRequest, ByteBucket) /** Constructs the message body from the request's Entity object @param IHttpRequest The request form which to extract the body @param ByteBucket The message body in plain-text form */
+ ExtractEntity (IHttpResponse, ByteBucket) /** Constructs the Entity object for the response, based on the ContentType @param IHttpResponse The response into which to add the entity representation of the body @param ByteBucket The message body in plain-text form */
# Initialize ()
+ LogMessage (character, integer) /** Logs a message @param character The message to log @param integer The level this message should be logged at */

Constructor Summary
Options Name Purpose
# ABLSocketLibrary (character, character, ClientSocket, ClientSocketConnectionParameters) /** Constructor. @param character This library's name @param character This library's version (semver) @param JsonObject Valid JSON containing config information */

Property Summary
Options Name Purpose
# CHARACTER LibraryName /** (mandatory) A free-text name for this library. Used for the USER-AGENT string. */
# CHARACTER LibraryVersion /** (mandatory) A free-text semantic version string for this library. Used for the USER-AGENT string. */
+ INTEGER miErrorNo_ConnectionFailure
+ INTEGER miErrorNo_ConnectionTimeout
+ INTEGER miErrorNo_RequestReadTimeout
+ INTEGER miErrorNo_RequestTimeout /* Error numbers for errors returned in this class. Private since this class alone will use them and read only to avoid anyone messing with them. A property to prevent changes. */
+ INTEGER miErrorNo_RequestWriteTimeout


Method Detail
Top

PROTECTED DataReceivedHandler (ClientSocket, SocketReadEventArgs)
Purpose: Event handler for dealing with data received from the ClientSocket
Parameters:
poSender OpenEdge.Net.ServerConnection.ClientSocket
poEventArgs OpenEdge.Net.ServerConnection.SocketReadEventArgs
Top

PROTECTED Destroy ()
Top

PROTECTED Execute (IHttpRequest, IHttpResponse)
Purpose: Executes an HTTP request, and returns a response
Parameters:
poRequest OpenEdge.Net.HTTP.IHttpRequest
poResponse OpenEdge.Net.HTTP.IHttpResponse
Top

PUBLIC ExtractBody (IHttpRequest, ByteBucket)
Purpose: Constructs the message body from the request's Entity object
Parameters:
poRequest OpenEdge.Net.HTTP.IHttpRequest
poMessageBody OpenEdge.Core.ByteBucket
Top

PUBLIC ExtractEntity (IHttpResponse, ByteBucket)
Purpose: Constructs the Entity object for the response, based on the
ContentType
Parameters:
poResponse OpenEdge.Net.HTTP.IHttpResponse
poMessageBody OpenEdge.Core.ByteBucket
Top

PROTECTED Initialize ()
Top

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


Constructor Detail
Top

PROTECTED ABLSocketLibrary (character, character, ClientSocket, ClientSocketConnectionParameters)
Purpose: Constructor.
Parameters:
pcLibraryName CHARACTER
pcLibraryVersion CHARACTER
poSocket OpenEdge.Net.ServerConnection.ClientSocket
poSocketConnectionParams OpenEdge.Net.ServerConnection.ClientSocketConnectionParameters


Property Detail
Top

PROTECTED CHARACTER LibraryName
Purpose: (mandatory) A free-text name for this library. Used for the USER-AGENT
string.
Returns CHARACTER
Top

PROTECTED CHARACTER LibraryVersion
Purpose: (mandatory) A free-text semantic version string for this library. Used for the USER-AGENT
string.
Returns CHARACTER
Top

PUBLIC INTEGER miErrorNo_ConnectionFailure
Returns INTEGER
Top

PUBLIC INTEGER miErrorNo_ConnectionTimeout
Returns INTEGER
Top

PUBLIC INTEGER miErrorNo_RequestReadTimeout
Returns INTEGER
Top

PUBLIC INTEGER miErrorNo_RequestTimeout
/* Error numbers for errors returned in this class. Private since this class
alone will use them and read only to avoid anyone messing with them.
A property to prevent changes.
Returns INTEGER
Top

PUBLIC INTEGER miErrorNo_RequestWriteTimeout
Returns INTEGER


10.27.2015 12:36:50