Tomcat 10.1.19 · org.apache.tomcat.websocket.server.WsWriteTimeout

Provides timeouts for asynchronous web socket writes. On the server side we only have access to jakarta.servlet.ServletOutputStream and jakarta.servlet.ServletInputStream so there is no way to set a timeout for writes to the client.

Field Summary

Modifier and Type	Field and Description
private int	backgroundProcessCount
private final AtomicInteger	count
private final Set<WsRemoteEndpointImplServer>	endpoints Note The comparator imposes orderings that are inconsistent with equals
private volatile int	processPeriod

Access	Constructor and Description
public	WsWriteTimeout()

Modifier and Type	Method and Description
public void	backgroundProcess() Implements org.apache.tomcat.websocket.BackgroundProcess.backgroundProcess.
public int	getProcessPeriod() Implements org.apache.tomcat.websocket.BackgroundProcess.getProcessPeriod. The default value is 1 which means asynchronous write timeouts are processed every 1 second.
public void	register(WsRemoteEndpointImplServer endpoint)
public void	setProcessPeriod(int period) Implements org.apache.tomcat.websocket.BackgroundProcess.setProcessPeriod.
public void	unregister(WsRemoteEndpointImplServer endpoint)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

backgroundProcessCount	back to summary
private int backgroundProcessCount

count	back to summary
private final AtomicInteger count

endpoints	back to summary
private final Set<WsRemoteEndpointImplServer> endpoints Note The comparator imposes orderings that are inconsistent with equals

processPeriod	back to summary
private volatile int processPeriod

WsWriteTimeout	back to summary
public WsWriteTimeout()

backgroundProcess	back to summary
public void backgroundProcess() Implements org.apache.tomcat.websocket.BackgroundProcess.backgroundProcess. Annotations @Override

backgroundProcess

public void backgroundProcess()

Annotations

getProcessPeriod	back to summary
public int getProcessPeriod() Implements org.apache.tomcat.websocket.BackgroundProcess.getProcessPeriod. The default value is 1 which means asynchronous write timeouts are processed every 1 second. Annotations @Override

getProcessPeriod

public int getProcessPeriod()

The default value is 1 which means asynchronous write timeouts are processed every 1 second.

Annotations