Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Avoid thread pinning in SseEmitter, ResponseBodyEmitter #35423

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;
import java.util.concurrent.locks.Lock;
import java.util.concurrent.locks.ReentrantLock;
import java.util.function.Consumer;

import org.jspecify.annotations.Nullable;
Expand Down Expand Up @@ -63,6 +65,7 @@
* @author Rossen Stoyanchev
* @author Juergen Hoeller
* @author Brian Clozel
* @author Taeik Lim
* @since 4.2
*/
public class ResponseBodyEmitter {
Expand All @@ -86,6 +89,8 @@ public class ResponseBodyEmitter {

private final DefaultCallback completionCallback = new DefaultCallback();

/** Guards access to write operations on the response. */
protected final Lock writeLock = new ReentrantLock();

/**
* Create a new ResponseBodyEmitter instance.
Expand Down Expand Up @@ -114,36 +119,48 @@ public ResponseBodyEmitter(Long timeout) {
}


synchronized void initialize(Handler handler) throws IOException {
this.handler = handler;

void initialize(Handler handler) throws IOException {
this.writeLock.lock();
try {
sendInternal(this.earlySendAttempts);
}
finally {
this.earlySendAttempts.clear();
}
this.handler = handler;

try {
sendInternal(this.earlySendAttempts);
}
finally {
this.earlySendAttempts.clear();
}

if (this.complete) {
if (this.failure != null) {
this.handler.completeWithError(this.failure);
if (this.complete) {
if (this.failure != null) {
this.handler.completeWithError(this.failure);
}
else {
this.handler.complete();
}
}
else {
this.handler.complete();
this.handler.onTimeout(this.timeoutCallback);
this.handler.onError(this.errorCallback);
this.handler.onCompletion(this.completionCallback);
}
}
else {
this.handler.onTimeout(this.timeoutCallback);
this.handler.onError(this.errorCallback);
this.handler.onCompletion(this.completionCallback);
finally {
this.writeLock.unlock();
}
}

synchronized void initializeWithError(Throwable ex) {
this.complete = true;
this.failure = ex;
this.earlySendAttempts.clear();
this.errorCallback.accept(ex);
void initializeWithError(Throwable ex) {
this.writeLock.lock();
try {
this.complete = true;
this.failure = ex;
this.earlySendAttempts.clear();
this.errorCallback.accept(ex);
}
finally {
this.writeLock.unlock();
}
}

/**
Expand Down Expand Up @@ -180,22 +197,28 @@ public void send(Object object) throws IOException {
* @throws IOException raised when an I/O error occurs
* @throws java.lang.IllegalStateException wraps any other errors
*/
public synchronized void send(Object object, @Nullable MediaType mediaType) throws IOException {
public void send(Object object, @Nullable MediaType mediaType) throws IOException {
Assert.state(!this.complete, () -> "ResponseBodyEmitter has already completed" +
(this.failure != null ? " with error: " + this.failure : ""));
if (this.handler != null) {
try {
this.handler.send(object, mediaType);
}
catch (IOException ex) {
throw ex;
this.writeLock.lock();
try {
if (this.handler != null) {
try {
this.handler.send(object, mediaType);
}
catch (IOException ex) {
throw ex;
}
catch (Throwable ex) {
throw new IllegalStateException("Failed to send " + object, ex);
}
}
catch (Throwable ex) {
throw new IllegalStateException("Failed to send " + object, ex);
else {
this.earlySendAttempts.add(new DataWithMediaType(object, mediaType));
}
}
else {
this.earlySendAttempts.add(new DataWithMediaType(object, mediaType));
finally {
this.writeLock.unlock();
}
}

Expand All @@ -208,10 +231,16 @@ public synchronized void send(Object object, @Nullable MediaType mediaType) thro
* @throws java.lang.IllegalStateException wraps any other errors
* @since 6.0.12
*/
public synchronized void send(Set<DataWithMediaType> items) throws IOException {
public void send(Set<DataWithMediaType> items) throws IOException {
Assert.state(!this.complete, () -> "ResponseBodyEmitter has already completed" +
(this.failure != null ? " with error: " + this.failure : ""));
sendInternal(items);
this.writeLock.lock();
try {
sendInternal(items);
}
finally {
this.writeLock.unlock();
}
}

private void sendInternal(Set<DataWithMediaType> items) throws IOException {
Expand Down Expand Up @@ -242,10 +271,16 @@ private void sendInternal(Set<DataWithMediaType> items) throws IOException {
* to complete request processing. It should not be used after container
* related events such as an error while {@link #send(Object) sending}.
*/
public synchronized void complete() {
this.complete = true;
if (this.handler != null) {
this.handler.complete();
public void complete() {
this.writeLock.lock();
try {
this.complete = true;
if (this.handler != null) {
this.handler.complete();
}
}
finally {
this.writeLock.unlock();
}
}

Expand All @@ -260,11 +295,17 @@ public synchronized void complete() {
* container related events such as an error while
* {@link #send(Object) sending}.
*/
public synchronized void completeWithError(Throwable ex) {
this.complete = true;
this.failure = ex;
if (this.handler != null) {
this.handler.completeWithError(ex);
public void completeWithError(Throwable ex) {
this.writeLock.lock();
try {
this.complete = true;
this.failure = ex;
if (this.handler != null) {
this.handler.completeWithError(ex);
}
}
finally {
this.writeLock.unlock();
}
}

Expand All @@ -273,8 +314,14 @@ public synchronized void completeWithError(Throwable ex) {
* called from a container thread when an async request times out.
* <p>As of 6.2, one can register multiple callbacks for this event.
*/
public synchronized void onTimeout(Runnable callback) {
this.timeoutCallback.addDelegate(callback);
public void onTimeout(Runnable callback) {
this.writeLock.lock();
try {
this.timeoutCallback.addDelegate(callback);
}
finally {
this.writeLock.unlock();
}
}

/**
Expand All @@ -284,8 +331,14 @@ public synchronized void onTimeout(Runnable callback) {
* <p>As of 6.2, one can register multiple callbacks for this event.
* @since 5.0
*/
public synchronized void onError(Consumer<Throwable> callback) {
this.errorCallback.addDelegate(callback);
public void onError(Consumer<Throwable> callback) {
this.writeLock.lock();
try {
this.errorCallback.addDelegate(callback);
}
finally {
this.writeLock.unlock();
}
}

/**
Expand All @@ -295,8 +348,14 @@ public synchronized void onError(Consumer<Throwable> callback) {
* detecting that a {@code ResponseBodyEmitter} instance is no longer usable.
* <p>As of 6.2, one can register multiple callbacks for this event.
*/
public synchronized void onCompletion(Runnable callback) {
this.completionCallback.addDelegate(callback);
public void onCompletion(Runnable callback) {
this.writeLock.lock();
try {
this.completionCallback.addDelegate(callback);
}
finally {
this.writeLock.unlock();
}
}


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,6 @@
import java.util.Collections;
import java.util.LinkedHashSet;
import java.util.Set;
import java.util.concurrent.locks.Lock;
import java.util.concurrent.locks.ReentrantLock;

import org.jspecify.annotations.Nullable;

Expand All @@ -41,16 +39,13 @@
* @author Juergen Hoeller
* @author Sam Brannen
* @author Brian Clozel
* @author Taeik Lim
* @since 4.2
*/
public class SseEmitter extends ResponseBodyEmitter {

private static final MediaType TEXT_PLAIN = new MediaType("text", "plain", StandardCharsets.UTF_8);

/** Guards access to write operations on the response. */
private final Lock writeLock = new ReentrantLock();
Copy link
Contributor Author

@acktsap acktsap Sep 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just moved this field to the upper level & changed it to protected



/**
* Create a new SseEmitter instance.
*/
Expand Down

AltStyle によって変換されたページ (->オリジナル) /