Module SimpleHttpServer

Package dev.katsute.simplehttpserver.handler.throttler

Class ServerSessionThrottler

java.lang.Object

dev.katsute.simplehttpserver.handler.throttler.ServerSessionThrottler

public class ServerSessionThrottler
extends Object

A throttler that limits the amount of simultaneous connections based on individual and total sessions.

Since:

5.0.0

Version:

5.0.0

Author:

Katsute

See Also:

• ConnectionThrottler
• HttpSession
• SessionThrottler

Constructor Summary

Constructors

Constructor	Description
ServerSessionThrottler(HttpSessionHandler sessionHandler)	Creates a throttler with no total connection limit.
ServerSessionThrottler(HttpSessionHandler sessionHandler, int maxConnections)	Creates a throttler with a limit on max total connections.

Method Summary

Modifier and Type	Method	Description
boolean	canIgnoreConnectionLimit(HttpSession session, SimpleHttpExchange exchange)	If true, a session does not contribute to the total server connections and can bypass the maximum limit.
int	getMaxConnections(HttpSession session, SimpleHttpExchange exchange)	Returns the maximum number of connections allowed for a session.
final int	getMaxConnections(SimpleHttpExchange exchange)	Returns the maximum number of connections allowed for an exchange.
final int	getMaxServerConnections()	Returns the maximum amount of server connections that is allowed.
final void	setMaxServerConnections(int connections)	Sets the maximum amount of server connections that is allowed.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ServerSessionThrottler

public ServerSessionThrottler(HttpSessionHandler sessionHandler)

Creates a throttler with no total connection limit.

Parameters:

sessionHandler - session handler

Since:

5.0.0

See Also:

• HttpSessionHandler

ServerSessionThrottler

public ServerSessionThrottler(HttpSessionHandler sessionHandler,
 int maxConnections)

Creates a throttler with a limit on max total connections.

Parameters:

sessionHandler - session handler

maxConnections - max total connections

Since:

5.0.0

See Also:

• HttpSessionHandler

Method Details

getMaxConnections

public final int getMaxConnections(SimpleHttpExchange exchange)

Returns the maximum number of connections allowed for an exchange. Return -1 for unlimited connections.

Parameters:

exchange - exchange

Returns:

maximum connections

See Also:

• SimpleHttpExchange

getMaxConnections

public int getMaxConnections(HttpSession session,
 SimpleHttpExchange exchange)

Returns the maximum number of connections allowed for a session. Return -1 for unlimited connections.

Parameters:

session - session

exchange - exchange

Returns:

maximum connections

Since:

5.0.0

See Also:

• HttpSession
• SimpleHttpExchange

canIgnoreConnectionLimit

public boolean canIgnoreConnectionLimit(HttpSession session,
 SimpleHttpExchange exchange)

If true, a session does not contribute to the total server connections and can bypass the maximum limit. Still limited by getMaxConnections(SimpleHttpExchange).

Parameters:

session - session

exchange - exchange

Returns:

if exchange can bypass limit

Since:

5.0.0

See Also:

• HttpSession
• SimpleHttpExchange

setMaxServerConnections

public final void setMaxServerConnections(int connections)

Sets the maximum amount of server connections that is allowed.

Parameters:

connections - max connections

Since:

5.0.0

See Also:

• getMaxServerConnections()

getMaxServerConnections

public final int getMaxServerConnections()

Returns the maximum amount of server connections that is allowed.

Returns:

max connections

Since:

5.0.0

See Also:

• setMaxServerConnections(int)

toString

public String toString()

Overrides:

toString in class Object