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.Logging.ISupportLogging

Copyright (c) 2014-2016 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 */
Execute (IHttpRequest, IHttpResponse) /** Executes an HTTP request, and returns a response Timeouts: - the connect and write-data calls are controlled by STOP-AFTER - the read-data calls (WaitForResponse) are handled by the socket @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 */
ReadTerminatedHandler (ClientSocket, SocketReadEventArgs) /** Event handler for dealing with ReadTerminated events received from the ClientSocket @param ClientSocket The socket object receiving the response @param SocketReadEventArgs Arguments pertaining to the data received */
ReadTimeoutHandler (ClientSocket, SocketReadEventArgs) /** Event handler for dealing with read timeouts received from the ClientSocket @param ClientSocket The socket object receiving the response @param SocketReadEventArgs Arguments pertaining to the data received */

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 ClientSocket The socket used to execute the request @param ClientSocketConnectionParameters Connection information for the server used */
ABLSocketLibrary (character, character, ClientSocket, ClientSocketConnectionParameters, ClientOptions) /** Constructor. @param character This library's name @param character This library's version (semver) @param ClientSocket The socket used to execute the request @param ClientSocketConnectionParameters Connection information for the server used @param ClientOptions Options */

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. */
OpenEdge.Logging.ILogWriter Logger
INTEGER miErrorNo_ConnectionFailure
INTEGER miErrorNo_ConnectionTimeout
INTEGER miErrorNo_RequestReadTerminated
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
OpenEdge.Net.HTTP.ClientOptions Options /** Miscellanous options (like timeouts) for this client. May be used to set underlying timeouts */


Method Detail
Top

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

Execute (IHttpRequest, IHttpResponse)
Purpose: Executes an HTTP request, and returns a response
Timeouts:
- the connect and write-data calls are controlled by STOP-AFTER
- the read-data calls (WaitForResponse) are handled by the socket
Parameters:
poRequest OpenEdge.Net.HTTP.IHttpRequest
poResponse OpenEdge.Net.HTTP.IHttpResponse
Top

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

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

ReadTerminatedHandler (ClientSocket, SocketReadEventArgs)
Purpose: Event handler for dealing with ReadTerminated events received from the ClientSocket
Parameters:
poSender OpenEdge.Net.ServerConnection.ClientSocket
poEventArgs OpenEdge.Net.ServerConnection.SocketReadEventArgs
Top

ReadTimeoutHandler (ClientSocket, SocketReadEventArgs)
Purpose: Event handler for dealing with read timeouts received from the ClientSocket
Parameters:
poSender OpenEdge.Net.ServerConnection.ClientSocket
poEventArgs OpenEdge.Net.ServerConnection.SocketReadEventArgs


Constructor Detail
Top

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

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


Property Detail
Top

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

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

OpenEdge.Logging.ILogWriter Logger
Returns OpenEdge.Logging.ILogWriter
Top

INTEGER miErrorNo_ConnectionFailure
Returns INTEGER
Top

INTEGER miErrorNo_ConnectionTimeout
Returns INTEGER
Top

INTEGER miErrorNo_RequestReadTerminated
Returns INTEGER
Top

INTEGER miErrorNo_RequestReadTimeout
Returns INTEGER
Top

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

INTEGER miErrorNo_RequestWriteTimeout
Returns INTEGER
Top

OpenEdge.Net.HTTP.ClientOptions Options
Purpose: Miscellanous options (like timeouts) for this client. May be used to set underlying timeouts
Returns OpenEdge.Net.HTTP.ClientOptions


Copyright © 2017 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 11.7