TIdSocketHandle.SetSockOpt Method

Sets socket options for the socket handle in the connection.

Pascal

procedure SetSockOpt(
    ALevel: TIdSocketOptionLevel; 
    AOptName: TIdSocketOption; 
    AOptVal: Integer
);

Parameters

Parameters	Description
Level	Option level Id_SOL_SOCKET, Id_IPPROTO_TCP, or Id_IPPROTO_IP.
OptName	Socket option to receive the option value.
OptVal	Value for the requested option.

Description

SetSockOpt is a procedure used to set socket options for the socket handle in the connection.

SetSockOpt calls the SetSocketOption API in GStack using the Handle for the connection, ALevel, AOptName, and AOptVal as arguments.

Options can control socket operations such as receiving Out-Of-Band data, broadcasting datagram packets, and much more.

There are two types of socket options: Boolean and Data. Boolean options enable or disable a specific feature. Use a zero value in OptVal to disable a feature, and a non-zero value in OptVal to enable the feature.

Data options require the address used to store the value or structure in OptVal.

OptNames use the constant values that include:

Option Name	Type	Usage
Id_SO_BROADCAST	Boolean	Allow transmission of broadcast messages on the socket.
Id_SO_DEBUG	Boolean	Record debugging information.
Id_SO_DONTLINGER	Boolean	Don't block CloseSocket for unsent data.
Id_SO_DONTROUTE	Boolean	Don't route dsata, send it directly to the interface.
Id_SO_KEEPALIVE	Boolean	Send keepalive packets.
Id_SO_LINGER	Data	Linger on close if unsent data is present.
Id_SO_OOBINLINE	Boolean	Receive out-of-band data in the normal data stream.
Id_SO_RCVBUF	Data	Integer buffer size for receives.
Id_SO_REUSEADDR	Boolean	Allow the socket to be bound to an address which is already in use.
Id_SO_SNDBUF	Data	Integer buffer size for sends.
Id_SO_RCVTIMEO	Data	Integer Receive timeout.
Id_SO_SNDTIMEO	Data	Integer Send timeout.
Id_IP_TTL	Data	Integer Time-To-Live for IP header fields.
Id_TCP_NODELAY	Boolean	Disables Nagle algorithm for send coalescing.

Related Information

TIdSocketHandle Class, TIdSocketHandle Members

Internet Direct (Indy) version 10.1.5
Copyright © 1993-2006, Chad Z. Hower (aka Kudzu) and the Indy Pit Crew. All rights reserved.
Website http://www.indyproject.org.
Post feedback to the Indy Documentation newsgroup.