Progress
Language Reference


Socket Object Handle

Interfaces
OS
SpeedScript
All
All
Yes

A handle to a socket object. This object allows you to read or write data on a TCP/IP socket and to perform other TCP/IP socket actions.

SYNTAX

socket-handle [ :attribute | :method ] 

socket-handle

A handle variable that references a socket object created by the CREATE SOCKET statement and that allows you to connect to, read from and write to a socket.

attribute

An attribute of the socket handle. The attributes are listed in the table that follows:

Attribute
Type
Readable
Setable
INTEGER
INTEGER
HANDLE
CHARACTER
INTEGER
CHARACTER
HANDLE
HANDLE
CHARACTER
CHARACTER
INTEGER
LOGICAL
CHARACTER

method

A method of the socket handle. The methods are listed in the table that follows:

Method
Return Type
Description
LOGICAL
Connects a socket handle to a specified TCP/IP port on a specified host.
LOGICAL
Indicates if a socket handle is currently connected to a port.
LOGICAL
Terminates the connection between a socket handle and the port to which it is connected.
INTEGER
Indicates the number of bytes available for reading from the socket.
CHARACTER
Returns a comma separated string containing values appropriate for the socket option specified.
LOGICAL
Reads data from the socket.
LOGICAL
Identifies the name of the procedure that is invoked when a READ-RESPONSE event occurs.
LOGICAL
Sets the specified socket options.
LOGICAL
Writes data to the socket.

EVENTS

Event Type
Supported

NOTE

The server socket object is used to enable connections from socket clients; it is via the socket object that clients and servers communicate. For more information on using sockets, see the Progress External Program Interfaces manual.


Copyright © 2004 Progress Software Corporation
www.progress.com
Voice: (781) 280-4000
Fax: (781) 280-4095