TElSocket.ShutdownSocket method

Discuss this help topic in SecureBlackbox Forum

TElSocket.ShutdownSocket

TElSocket See also

Filter: C# VB.NET Pascal C++ PHP Java

Initiates shutdown of sending or receiving channel of the socket.

Declaration

[C#]
void ShutdownSocket();
void ShutdownSocket(TElShutdownDirection Direction);

[VB.NET]
Sub ShutdownSocket()
Sub ShutdownSocket(ByVal Direction As TElShutdownDirection)

[Pascal]
procedure ShutdownSocket();
procedure ShutdownSocket(Direction : TElShutdownDirection);

[C++]
void ShutdownSocket();
void ShutdownSocket(TElShutdownDirection Direction);

[PHP]
void ShutdownSocket()
void ShutdownSocket(integer $Direction)

[Java]
void shutdownSocket(TElShutdownDirection Direction);
void shutdownSocket();

Parameters

Direction - specifies the direction of the channel to be shut down.

Possible values:

[.NET] [C++]	[Pascal]	Description
sdReceive = 0	sdReceive	Specifies receiving channel
sdSend = 1	sdSend	Specifies sending channel
sdSendAndReceive = 2	sdSendAndReceive	Specifies sending and receiving channel

Description

This method corresponds to the shutdown() function of sockets API. It initiates shutdown of sending or receiving channel of the socket. After the channel is shut down, no sending or receiving can take place. However, it is a designed scenario to shutdown the sending end, and then peek the remaining data using Receive method.
ShutdownSocket method is optional, if you don't need the remaining data (or the application-level protocol shuts down the socket only after everything was sent or received), then there's no need to call ShutdownSocket. Close method will do everything itself in this case (unless Silent parameter of Close method is True).

See also: Close Receive

Discuss this help topic in SecureBlackbox Forum