Skip to content

Commit 45b5af1

Browse files
committed
Implement custom events framework in gRPC-Java server
This adds triggerEvent/onEvent APIs to ServerCall and ServerCall.Listener, routing them through ServerStream transport to ensure thread-safety (especially for SerializeReentrantCallsDirectExecutor). TAG=agy CONV=e1bfa5a2-e855-4f79-abdd-ef2b264977be
1 parent 7fdcde1 commit 45b5af1

10 files changed

Lines changed: 150 additions & 0 deletions

File tree

‎api/src/main/java/io/grpc/ServerCall.java‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,19 @@ public void onComplete() {}
100100
* <em>another</em> {@code onReady()} callback.
101101
*/
102102
public void onReady() {}
103+
104+
/**
105+
* A custom event has been triggered by the call.
106+
*
107+
* <p>This callback is guaranteed to run on the call's executor, serialized with other
108+
* callbacks (like {@link #onMessage}, {@link #onHalfClose}). This means the implementation
109+
* does not need internal synchronization to access call-specific state.
110+
*
111+
* @param event the triggered event.
112+
*/
113+
public void onEvent(Object event) {
114+
// Default no-op
115+
}
103116
}
104117

105118
/**
@@ -262,6 +275,18 @@ public String getAuthority() {
262275
return null;
263276
}
264277

278+
/**
279+
* Triggers a custom event to be processed by the listener.
280+
* The event will be delivered to {@link Listener#onEvent(Object)} on the call's executor.
281+
*
282+
* <p>This method is thread-safe and can be called from any thread.
283+
*
284+
* @param event the event to trigger.
285+
*/
286+
public void triggerEvent(Object event) {
287+
// Default no-op
288+
}
289+
265290
/**
266291
* The {@link MethodDescriptor} for the call.
267292
*/

‎core/src/main/java/io/grpc/internal/AbstractServerStream.java‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,18 @@ public final void setListener(ServerStreamListener serverStreamListener) {
173173
transportState().setListener(serverStreamListener);
174174
}
175175

176+
@Override
177+
public final void triggerEvent(final Object event) {
178+
transportState().runOnTransportThread(new Runnable() {
179+
@Override
180+
public void run() {
181+
if (transportState().listener != null) {
182+
transportState().listener.triggerEvent(event);
183+
}
184+
}
185+
});
186+
}
187+
176188
@Override
177189
public StatsTraceContext statsTraceContext() {
178190
return statsTraceCtx;

‎core/src/main/java/io/grpc/internal/ServerCallImpl.java‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -254,6 +254,11 @@ public MethodDescriptor<ReqT, RespT> getMethodDescriptor() {
254254
return method;
255255
}
256256

257+
@Override
258+
public void triggerEvent(Object event) {
259+
stream.triggerEvent(event);
260+
}
261+
257262
@Override
258263
public SecurityLevel getSecurityLevel() {
259264
final Attributes attributes = getAttributes();
@@ -395,5 +400,13 @@ public void onReady() {
395400
listener.onReady();
396401
}
397402
}
403+
404+
@Override
405+
public void triggerEvent(Object event) {
406+
if (call.cancelled) {
407+
return;
408+
}
409+
listener.onEvent(event);
410+
}
398411
}
399412
}

‎core/src/main/java/io/grpc/internal/ServerImpl.java‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -781,6 +781,9 @@ public void closed(Status status) {}
781781

782782
@Override
783783
public void onReady() {}
784+
785+
@Override
786+
public void triggerEvent(Object event) {}
784787
}
785788

786789
/**
@@ -960,6 +963,34 @@ public void runInContext() {
960963
callExecutor.execute(new OnReady());
961964
}
962965
}
966+
967+
@Override
968+
public void triggerEvent(final Object event) {
969+
try (TaskCloseable ignore = PerfMark.traceTask("ServerStreamListener.triggerEvent")) {
970+
PerfMark.attachTag(tag);
971+
final Link link = PerfMark.linkOut();
972+
973+
final class TriggerEvent extends ContextRunnable {
974+
TriggerEvent() {
975+
super(context);
976+
}
977+
978+
@Override
979+
public void runInContext() {
980+
try (TaskCloseable ignore = PerfMark.traceTask("ServerCallListener(app).onEvent")) {
981+
PerfMark.attachTag(tag);
982+
PerfMark.linkIn(link);
983+
getListener().triggerEvent(event);
984+
} catch (Throwable t) {
985+
internalClose(t);
986+
throw t;
987+
}
988+
}
989+
}
990+
991+
callExecutor.execute(new TriggerEvent());
992+
}
993+
}
963994
}
964995

965996
@VisibleForTesting

‎core/src/main/java/io/grpc/internal/ServerStream.java‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,12 @@ public interface ServerStream extends Stream {
8787
*/
8888
void setListener(ServerStreamListener serverStreamListener);
8989

90+
/**
91+
* Triggers a custom event. Implementations must ensure this is propagated to the
92+
* listener on the transport thread.
93+
*/
94+
void triggerEvent(Object event);
95+
9096
/**
9197
* The context for recording stats and traces for this stream.
9298
*/

‎core/src/main/java/io/grpc/internal/ServerStreamListener.java‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,4 +42,9 @@ public interface ServerStreamListener extends StreamListener {
4242
* @param status details about the remote closure
4343
*/
4444
void closed(Status status);
45+
46+
/**
47+
* Propagates a custom event to the listener. Must be called on the transport thread.
48+
*/
49+
void triggerEvent(Object event);
4550
}

‎core/src/test/java/io/grpc/internal/AbstractServerStreamTest.java‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -391,6 +391,9 @@ public void halfClosed() {}
391391

392392
@Override
393393
public void closed(Status status) {}
394+
395+
@Override
396+
public void triggerEvent(Object event) {}
394397
}
395398

396399
private static class AbstractServerStreamBase extends AbstractServerStream {

‎core/src/test/java/io/grpc/internal/ServerCallImplTest.java‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -493,6 +493,32 @@ public void streamListener_unexpectedRuntimeException() {
493493
assertThat(e).hasMessageThat().isEqualTo("unexpected exception");
494494
}
495495

496+
@Test
497+
public void triggerEvent_propagatesToStream() {
498+
Object event = new Object();
499+
call.triggerEvent(event);
500+
verify(stream).triggerEvent(event);
501+
}
502+
503+
@Test
504+
public void streamListener_triggerEvent() {
505+
ServerStreamListenerImpl<Long> streamListener =
506+
new ServerCallImpl.ServerStreamListenerImpl<>(call, callListener, context);
507+
Object event = new Object();
508+
streamListener.triggerEvent(event);
509+
verify(callListener).onEvent(event);
510+
}
511+
512+
@Test
513+
public void streamListener_triggerEvent_cancelled() {
514+
ServerStreamListenerImpl<Long> streamListener =
515+
new ServerCallImpl.ServerStreamListenerImpl<>(call, callListener, context);
516+
Object event = new Object();
517+
streamListener.closed(Status.CANCELLED);
518+
streamListener.triggerEvent(event);
519+
verify(callListener, never()).onEvent(event);
520+
}
521+
496522
private static class LongMarshaller implements Marshaller<Long> {
497523
@Override
498524
public InputStream stream(Long value) {

‎core/src/testFixtures/java/io/grpc/internal/ServerStreamListenerBase.java‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,11 +89,21 @@ public void halfClosed() {
8989
halfClosedLatch.countDown();
9090
}
9191

92+
public final BlockingQueue<Object> eventQueue = new LinkedBlockingQueue<>();
93+
9294
@Override
9395
public void closed(Status status) {
9496
if (this.status.isDone()) {
9597
fail("closed invoked more than once");
9698
}
9799
this.status.set(status);
98100
}
101+
102+
@Override
103+
public void triggerEvent(Object event) {
104+
if (this.status.isDone()) {
105+
fail("triggerEvent invoked after closed");
106+
}
107+
eventQueue.add(event);
108+
}
99109
}

‎inprocess/src/main/java/io/grpc/inprocess/InProcessTransport.java‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -429,6 +429,11 @@ public void setListener(ServerStreamListener serverStreamListener) {
429429
clientStream.setListener(serverStreamListener);
430430
}
431431

432+
@Override
433+
public void triggerEvent(Object event) {
434+
clientStream.triggerServerEvent(event);
435+
}
436+
432437
@Override
433438
public void request(int numMessages) {
434439
boolean onReady = clientStream.serverRequested(numMessages);
@@ -732,6 +737,20 @@ private synchronized void setListener(ServerStreamListener listener) {
732737
this.serverStreamListener = listener;
733738
}
734739

740+
void triggerServerEvent(final Object event) {
741+
synchronized (this) {
742+
if (!closed && serverStreamListener != null) {
743+
syncContext.executeLater(new Runnable() {
744+
@Override
745+
public void run() {
746+
serverStreamListener.triggerEvent(event);
747+
}
748+
});
749+
}
750+
}
751+
syncContext.drain();
752+
}
753+
735754
@Override
736755
public void request(int numMessages) {
737756
boolean onReady = serverStream.clientRequested(numMessages);

0 commit comments

Comments
 (0)