OpenEdge.Net.ServerConnection.ClientSocket
- Last Updated: November 12, 2026
- 4 minute read
- OpenEdge
- Version 13.1
- Documentation
|
Method Summary
| Options | Name | Purpose | |
|---|---|---|---|
| Connect () |
/**
* Connect to the server specified, based on existing ConnectionParameters
*/
|
||
| Connect (ClientSocketConnectionParameters) |
/**
* Connect to the server specified, based on passed-in Connection Parameters
*
* @param ClientSocketConnectionParameters Connection information for the connection.
*/
|
||
| Connect (URI) |
/**
* Connect to the server specified, based on passed-in URI
*
* @param URI Connection information for the connection.
*/
|
||
| CreateServer () |
/**
* Creates a server object (ie this-object:Server) as a Socket object.
* This is separated from the Connect/Disconnect pair of methods so that
* one server can be connected and disconnected multiple times.
*
* See official documentation for the Socket object handle:
* https://docs.progress.com/bundle/abl-reference/page/Socket-object-handle.html
*/
|
||
| DestroyServer () |
/**
* Destroys the server object (ie this-object:Server). This is separated
* from the Connect/Disconnect pair of methods so that one server can
* be connected and disconnected multiple time.
*/
|
||
| Disconnect () |
/**
* Disconnect from the server, if connected
*/
|
||
| LOGICAL IsConnected () |
/**
* Indicates whether we have a connection.
*
* @return logical TRUE if the socket is connected; false otherwise
*/
|
||
| OnDataReceived (SocketReadEventArgs) |
/**
* Publishes the DataReceived event.
*
* @param SocketReadEventArgs Arguments for this event
*/
|
||
| OnReadTerminated (SocketReadEventArgs) |
/**
* Publishes the ReadTerminated event.
*
* @param SocketReadEventArgs Arguments for this event
*/
|
||
| OnReadTimeout (SocketReadEventArgs) |
/**
* Publishes the ReadTimeout event.
*
* @param SocketReadEventArgs Arguments for this event
*/
|
||
| ReadResponseHandler () |
/**
* Callback/event procedure fired on the READ-RESPONSE event of the socket.
*/
|
||
| SetSocketOptions (handle) |
/**
* Sets the various socket options, per this object's properties.
*
* @param handle The socket on which to set these options
*/
|
||
| StartTls (character) |
/**
* Starts a new TLS (for insecure connections), or changes (for already-secure)
* connections, the certificates used to decrypt the traffic. Used primarily
* for HTTP proxy tunnelling.
*
* @param character The certificate subject (host) name
*/
|
||
| WaitForResponse () |
/**
* Waits for a response from a write event on the socket with a
* no timeout. Uses the default timeout, which is none/zero
*/
|
||
| WaitForResponse (decimal) |
/**
* Waits for a response from a write event on the socket. Polls
* (ie loops) for a response
*
* @param decimal A timeout value for read events in seconds. A zero value means no timeout.
*/
|
||
| WaitForResponseAsync (decimal) |
/**
* Waits for a response from a write event on the socket. Uses a WAIT-FOR loop
* to emulate/provide async.
*
* @param decimal A timeout value for read events in seconds. A zero value means no timeout.
*/
|
||
| WriteData (IMemoryPointer) |
|
||
| WriteData (Memptr) |
/**
* Writes data to the connected server.
*
* @param Memptr The data to be written to the socket.
*/
|
Constructor Summary
| Options | Name | Purpose | |
|---|---|---|---|
| ClientSocket () |
/**
* Default constructor. Connection parameters can be specified via the Connnect() method.
*/
|
||
| ClientSocket (ClientSocketConnectionParameters) |
/**
* Constructor.
*
* @param ClientSocketConnectionParameters A URI and other parameters that this socket will connect to.
*/
|
Event Summary
| Options | Name | Purpose | |
|---|---|---|---|
| DataReceived (ClientSocket, SocketReadEventArgs) |
/** Event fired when a chunk of data is received from the socket */
|
||
| ReadTerminated (ClientSocket, SocketReadEventArgs) |
/** Fired when a read is terminated for an reason (socket disconnect, no data etc) */
|
||
| ReadTimeout (ClientSocket, SocketReadEventArgs) |
/** Fired when a read times out (optional based on a timeout) */
|
Property Summary
| Options | Name | Purpose | |
|---|---|---|---|
| LOGICAL Connected |
|
||
| OpenEdge.Core.ServerConnection.IConnectionParameters ConnectionParameters |
|
||
| INTEGER DefaultReadTimeout |
|
||
| LOGICAL KeepAlive |
|
||
| INTEGER LingerTime |
|
||
| CHARACTER LocalHost |
|
||
| INTEGER LocalPort |
|
||
| OpenEdge.Logging.ILogWriter Logger |
|
||
| LOGICAL NoDelay |
|
||
| INTEGER ReadBufferSize |
|
||
| INTEGER ReceiveBufferSize |
|
||
| INTEGER ReceiveTimeout |
|
||
| CHARACTER RemoteHost |
|
||
| INTEGER RemotePort |
|
||
| LOGICAL ReuseAddress |
|
||
| INTEGER SendBufferSize |
|
||
| Progress.Lang.Object Server |
|
||
| CHARACTER SslServerName |
|
Method Detail
Constructor Detail
ClientSocket ()
|
||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
ClientSocket (ClientSocketConnectionParameters)
|
||||||||||||
Event Detail
DataReceived (ClientSocket, SocketReadEventArgs)
|
||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ReadTerminated (ClientSocket, SocketReadEventArgs)
|
||||||||||||||||
ReadTimeout (ClientSocket, SocketReadEventArgs)
|
||||||||||||||||
Property Detail
LOGICAL Connected
|
||||||||
|---|---|---|---|---|---|---|---|---|
OpenEdge.Core.ServerConnection.IConnectionParameters ConnectionParameters |
||||||||
INTEGER DefaultReadTimeout
|
||||||||
LOGICAL KeepAlive
|
||||||||
INTEGER LingerTime
|
||||||||
CHARACTER LocalHost
|
||||||||
INTEGER LocalPort
|
||||||||
OpenEdge.Logging.ILogWriter Logger
|
||||||||
LOGICAL NoDelay
|
||||||||
INTEGER ReadBufferSize
|
||||||||
INTEGER ReceiveBufferSize
|
||||||||
INTEGER ReceiveTimeout
|
||||||||
CHARACTER RemoteHost
|
||||||||
INTEGER RemotePort
|
||||||||
LOGICAL ReuseAddress
|
||||||||
INTEGER SendBufferSize
|
||||||||
Progress.Lang.Object Server
|
||||||||
CHARACTER SslServerName
|
||||||||