SocketTools .NET Edition

InternetServer.Throttle Method (Int32, Int32, Int32)

Limit the maximum number of client connections, connections per IP address and connection rate.

[Visual Basic]
Overloads Public Function Throttle( _
   ByVal maxClients As Integer, _
   ByVal maxClientsPerAddress As Integer, _
   ByVal connectionRate As Integer _
) As Boolean
[C#]
public bool Throttle(
   int maxClients,
   int maxClientsPerAddress,
   int connectionRate
);

Parameters

maxClients
An integer value that specifies the maximum number of clients that may connect to the server. A value of zero specifies that there is no fixed limit to the number of client connections.
maxClientsPerAddress
An integer value that specifies the maximum number of clients that may connect to the server from the same IP address. A value of zero specifies that there is no fixed limit to the number of client connections per address. By default, there is no limit on the number of client connections per address.
connectionRate
An integer value that specifies a restriction on the rate of client connections, limiting the number of connections that will be accepted within that period of time. A value of zero specifies that there is no restriction on the rate of client connections. The higher this value, the fewer the number of connections that will be accepted within a specific period of time. By default, there is no limit on the client connection rate.

Return Value

A boolean value which specifies if the method was successful. A return value of true indicates success. If an error occurs, the method returns false and the application should check the value of the LastError property to determine the cause of the failure.

Remarks

If the maximum number of client connections or maximum number of connections per address is exceeded, the server will reject subsequent connection attempts until the number of active client sessions drops below the specified threshold. Note that adjusting these values lower than the current connection limits will not affect clients that have already connected to the server. For example, if the Start method is called with the maximum number of clients set to 100, and then the Throttle method is called lowering that value to 75, no existing client connections will be affected by the change. However, the server will not accept any new connections until the number of active clients drops below 75.

Increasing the connection rate value will force the server to slow down the rate at which it will accept incoming client connection requests. For example, setting this parameter to a value of 1000 would limit the server to accepting one client connection every second, while a value of 250 would allow the server to accept four client connections per second. Note that significantly increasing the amount of time the server must wait to accept client connections can exceed the connection backlog queue, resulting in client connections being rejected.

See Also

InternetServer Class | SocketTools Namespace | InternetServer.Throttle Overload List