Powered by Zoomin Software. For more details please contactZoomin

OpenEdge ABL API Reference

OpenEdge.Net.HTTP.Lib.ABLSockets.ABLSocketLibrary

OpenEdge.Net.HTTP.Lib.ABLSockets.ABLSocketLibrary

  • Last Updated: November 12, 2026
  • 3 minute read
    • OpenEdge
    • Version 13.1
    • Documentation
Namespace: OpenEdge.Net.HTTP.Lib.ABLSockets
Type: Class ABLSocketLibrary
Parent Classes:
Inherits: Progress.Lang.Object
Implements: OpenEdge.Net.HTTP.IHttpClientLibrary, OpenEdge.Logging.ISupportLogging


Copyright (c) 2014-2019,2021,2023-2024 by Progress Software Corporation. All rights reserved.
File:ABLSocketLibrary
Purpose:Socket-based HTTP client library implementation
Description:Implements IHttpClientLibrary to provide HTTP client functionality
using the ABL Socket object handle for TCP/IP communications.
Created:Mon Jan 20 09:46:05 EST 2014
This class orchestrates HTTP request/response operations by:
- Connecting to servers using ClientSocket with configured parameters
- Serializing HTTP requests into raw socket messages
- Writing request data to the socket
- Reading response data via socket callbacks (DataReceivedHandler)
- Deserializing raw responses into IHttpResponse objects
- Managing timeouts, proxy tunneling, and error handling
Key components it works with:
- ClientSocket: Manages the underlying socket connection and I/O
- ClientSocketConnectionParameters: Connection settings (SSL, timeouts)
- MessageWriter/ResponseWriter: Serialization of requests/responses
- ClientOptions: HTTP-level options like request timeout
Created by ABLSocketLibraryBuilder from configuration options set
via ClientLibraryBuilder's fluent API.



Method Summary
  Options Name Purpose
  CreateTunnel (ISupportProxy) /** * Creates an HTTPS tunnel (using CONNECT) for the proxy request * * @param ISupportProxy The request to proxy */
  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 IHttpRequest The request to execute * @param IHttpResponse The response from the server for that request. */
  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 */
  MakeSyncRequest (ClientSocket, IHttpRequest, IHttpResponse, ByteBucket)
  MakeSyncRequest (ClientSocket, IHttpRequest, IHttpResponse, RawMessage)
  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 */
  OpenEdge.Net.HTTP.Filter.Payload.RawMessage SerializeRequest (IHttpRequest) /** * Serializes an HTTP request into a raw message for socket transmission. * * @param IHttpRequest The request to serialize * @return RawMessage The serialized request */

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
  CHARACTER LibraryVersion
  OpenEdge.Logging.ILogWriter Logger
  CHARACTER mcHeader_TraceParent
  CHARACTER mcHeader_TraceState
  INTEGER miErrorNo_BadRequest
  INTEGER miErrorNo_ConnectionFailure
  INTEGER miErrorNo_ConnectionTimeout
  INTEGER miErrorNo_MissingTlsCredentials
  INTEGER miErrorNo_RequestReadTerminated
  INTEGER miErrorNo_RequestReadTimeout
  INTEGER miErrorNo_RequestTimeout
  INTEGER miErrorNo_RequestWriteTimeout
  OpenEdge.Net.HTTP.ClientOptions Options


Method Detail
Top

CreateTunnel (ISupportProxy)

Purpose:
Parameters:
pProxyReq OpenEdge.Net.HTTP.ISupportProxy
 
Top

DataReceivedHandler (ClientSocket, SocketReadEventArgs)

Top

Execute (IHttpRequest, IHttpResponse)

Purpose:
Parameters:
poRequest OpenEdge.Net.HTTP.IHttpRequest
 
poResponse OpenEdge.Net.HTTP.IHttpResponse
 
Top

ExtractEntity (IHttpResponse, ByteBucket)

Purpose:
Parameters:
poResponse OpenEdge.Net.HTTP.IHttpResponse
 
poMessageBody OpenEdge.Core.ByteBucket
 
Top

MakeSyncRequest (ClientSocket, IHttpRequest, IHttpResponse, ByteBucket)

Top

MakeSyncRequest (ClientSocket, IHttpRequest, IHttpResponse, RawMessage)

Top

ReadTerminatedHandler (ClientSocket, SocketReadEventArgs)

Top

ReadTimeoutHandler (ClientSocket, SocketReadEventArgs)

Top

OpenEdge.Net.HTTP.Filter.Payload.RawMessage SerializeRequest (IHttpRequest)



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

Returns CHARACTER
 
Top

CHARACTER LibraryVersion

Returns CHARACTER
 
Top

OpenEdge.Logging.ILogWriter Logger

Top

CHARACTER mcHeader_TraceParent

Returns CHARACTER
 
Top

CHARACTER mcHeader_TraceState

Returns CHARACTER
 
Top

INTEGER miErrorNo_BadRequest

Returns INTEGER
 
Top

INTEGER miErrorNo_ConnectionFailure

Returns INTEGER
 
Top

INTEGER miErrorNo_ConnectionTimeout

Returns INTEGER
 
Top

INTEGER miErrorNo_MissingTlsCredentials

Returns INTEGER
 
Top

INTEGER miErrorNo_RequestReadTerminated

Returns INTEGER
 
Top

INTEGER miErrorNo_RequestReadTimeout

Returns INTEGER
 
Top

INTEGER miErrorNo_RequestTimeout

Returns INTEGER
 
Top

INTEGER miErrorNo_RequestWriteTimeout

Returns INTEGER
 
Top

OpenEdge.Net.HTTP.ClientOptions Options



Alert