Skip to content

expose flush on RCTWebSocketModule to close all open websockets synchronously #14

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
May 25, 2022
Merged

expose flush on RCTWebSocketModule to close all open websockets synchronously #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d62cbe8
expose `flush` on RCTWebSocketModule to close all open websockets syn…
May 24, 2022
7a0fa31
simplify code
May 25, 2022
f9769c7
simplify even more
May 25, 2022
b1e6171
change comment
May 25, 2022
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
2 changes: 2 additions & 0 deletions Libraries/WebSocket/RCTSRWebSocket.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,8 @@ extern NSString *const RCTSRHTTPResponseErrorKey;
- (void)open;

- (void)close;
- (void)flush;

- (void)closeWithCode:(NSInteger)code reason:(NSString *)reason;

// Send a UTF8 String or Data.
Expand Down
7 changes: 7 additions & 0 deletions Libraries/WebSocket/RCTSRWebSocket.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -549,6 +549,13 @@ - (void)unscheduleFromRunLoop:(NSRunLoop *)aRunLoop forMode:(NSString *)mode
[_scheduledRunloops removeObject:@[aRunLoop, mode]];
}

- (void)flush
{
// By queueing an empty block, all blocks queued before
// need to finish executing as this is a serial queue
dispatch_sync(_workQueue, ^{});
}

- (void)close
{
[self closeWithCode:RCTSRStatusCodeNormal reason:nil];
Expand Down
3 changes: 3 additions & 0 deletions React/CoreModules/RCTWebSocketModule.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ NS_ASSUME_NONNULL_BEGIN

- (void)sendData:(NSData *)data forSocketID:(nonnull NSNumber *)socketID;

// Blocking call that waits until there are no more remaining actions on the queue
- (void)flush;
Copy link

@donaldchen donaldchen May 25, 2022

Choose a reason for hiding this comment

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

nit / question on naming: does this method empty any buffers or perform any remaining actions in a queue? That's what the "flush" terminology makes me think. If the method does something like that, then the name makes sense. If it doesn't do that, then a name like closeAllSockets would be clearer to me.

Copy link
Author

@nealmanaktola nealmanaktola May 25, 2022

Choose a reason for hiding this comment

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

i updated the implementation + comment to be more in line with the function name (flush)

Copy link

@donaldchen donaldchen May 25, 2022

Choose a reason for hiding this comment

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

Thanks! The comments are helpful, and this makes more sense to me now


@end

@interface RCTBridge (RCTWebSocketModule)
Expand Down
8 changes: 8 additions & 0 deletions React/CoreModules/RCTWebSocketModule.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,14 @@ - (NSArray *)supportedEvents
return @[ @"websocketMessage", @"websocketOpen", @"websocketFailed", @"websocketClosed" ];
}


- (void)flush
Copy link
Author

@nealmanaktola nealmanaktola May 24, 2022

Choose a reason for hiding this comment

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

this function will be called from here: https://github.com/discord/discord/pull/72585

{
for (RCTSRWebSocket *socket in _sockets.allValues) {
[socket flush];
}
}

- (void)invalidate
{
[super invalidate];
Expand Down