Implement websocket keepalive #64
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
muzzammilshahid
force-pushed
the
ping-pong
branch
from
6d7b81c to
d9fc4c1
Compare
muzzammilshahid
force-pushed
the
ping-pong
branch
from
d9fc4c1 to
b86dad9
Compare
muzzammilshahid
force-pushed
the
ping-pong
branch
2 times, most recently
from
3fe558a to
a32f138
Compare
om26er
requested changes
Dec 26, 2024
acceptor.go
Outdated
| @@ -69,10 +70,11 @@ func (w *WebSocketAcceptor) Spec(subProtocol string) (serializers.Serializer, er | |||
| return serializer, nil | |||
| } | |||
|
|
|||
| func (w *WebSocketAcceptor) Accept(conn net.Conn) (BaseSession, error) { | |||
| func (w *WebSocketAcceptor) Accept(conn net.Conn, keepaliveInterval time.Duration, | |||
There was a problem hiding this comment.
these two parameters should be moved into WebSocketServerConfig and Accept should accept that.
acceptor_test.go
Outdated
| @@ -25,7 +26,7 @@ func TestAccept(t *testing.T) { | |||
| require.NotNil(t, conn) | |||
|
|
|||
| acceptor := xconn.WebSocketAcceptor{} | |||
| session, err := acceptor.Accept(conn) | |||
| session, err := acceptor.Accept(conn, time.Duration(0), time.Duration(0)) | |||
There was a problem hiding this comment.
this would then just become
Suggested change
| session, err := acceptor.Accept(conn, time.Duration(0), time.Duration(0)) | |
| session, err := acceptor.Accept(conn, nil) |
client.go
Outdated
Comment on lines
17
to
18
| KeepaliveInterval time.Duration | ||
| KeepaliveTimeout time.Duration |
There was a problem hiding this comment.
Suggested change
| KeepaliveInterval time.Duration | |
| KeepaliveTimeout time.Duration | |
| KeepAliveInterval time.Duration | |
| KeepAliveTimeout time.Duration |
joiner.go
Outdated
| @@ -22,7 +22,8 @@ type WebSocketJoiner struct { | |||
| DialTimeout time.Duration | |||
| } | |||
|
|
|||
| func (w *WebSocketJoiner) Join(ctx context.Context, url, realm string) (BaseSession, error) { | |||
| func (w *WebSocketJoiner) Join(ctx context.Context, url, realm string, keepaliveInterval time.Duration, | |||
There was a problem hiding this comment.
those new parameters should be moved inside WSDialerConfig struct. And this function should signature should that as last argument
peer.go
Outdated
| wsReader, wsWriter, err = ServerSideWSReaderWriter(binary) | ||
| } else { | ||
| wsReader, wsWriter, err = ClientSideWSReaderWriter(binary) | ||
| func NewWebSocketPeer(conn net.Conn, protocol string, binary, server bool, keepaliveInterval time.Duration, |
There was a problem hiding this comment.
create a new WSPeerConfig struct and move all parameters of this function there (except for conn)
peer.go
Outdated
| } | ||
|
|
||
| if err != nil { | ||
| return nil, err | ||
| if keepaliveInterval != 0*time.Second { |
There was a problem hiding this comment.
Suggested change
| if keepaliveInterval != 0*time.Second { | |
| if keepaliveInterval != 0 { |
peer.go
Outdated
| ticker := time.NewTicker(keepaliveInterval) | ||
| defer ticker.Stop() | ||
|
|
||
| if keepaliveTimeout == 0*time.Second { |
There was a problem hiding this comment.
Suggested change
| if keepaliveTimeout == 0*time.Second { | |
| if keepaliveTimeout == 0 { |
peer.go
Outdated
| select { | ||
| case <-c.pingCh: | ||
| case <-time.After(keepaliveTimeout): | ||
| log.Println("pong timeout, closing connection") |
There was a problem hiding this comment.
Suggested change
| log.Println("pong timeout, closing connection") | |
| log.Println("ping timeout, closing connection") |
peer.go
Outdated
| case ws.OpText, ws.OpBinary: | ||
| return payload, nil | ||
| case ws.OpPing: | ||
| err = c.writeOpFunc(c.conn, ws.OpPong, payload) |
server.go
Outdated
| } | ||
|
|
||
| func NewServer(router *Router, authenticator auth.ServerAuthenticator, throttle *internal.Throttle) *Server { | ||
| func NewServer(router *Router, authenticator auth.ServerAuthenticator, throttle *internal.Throttle, |
muzzammilshahid
force-pushed
the
ping-pong
branch
from
a32f138 to
ba42f2f
Compare
muzzammilshahid
force-pushed
the
ping-pong
branch
from
ba42f2f to
8561681
Compare
om26er
reviewed
Dec 27, 2024
joiner.go
Outdated
| } | ||
|
|
||
| func (w *WebSocketJoiner) Join(ctx context.Context, url, realm string) (BaseSession, error) { | ||
| func (w *WebSocketJoiner) Join(ctx context.Context, url, realm string, dialConfig WSDialerConfig) (BaseSession, error) { |
There was a problem hiding this comment.
Suggested change
| func (w *WebSocketJoiner) Join(ctx context.Context, url, realm string, dialConfig WSDialerConfig) (BaseSession, error) { | |
| func (w *WebSocketJoiner) Join(ctx context.Context, url, realm string, config *WSDialerConfig) (BaseSession, error) { |
we should also change DialWebSocket to accept pointer of config
muzzammilshahid
force-pushed
the
ping-pong
branch
from
8561681 to
d685e03
Compare
muzzammilshahid
force-pushed
the
ping-pong
branch
from
d685e03 to
3c8a518
Compare
om26er
requested changes
Dec 27, 2024
peer.go
Outdated
| for { | ||
| <-ticker.C | ||
| // Send a ping | ||
| err := c.writeOpFunc(c.conn, ws.OpPing, []byte("ping")) |
There was a problem hiding this comment.
instead of sending "ping" please send 4 random bytes
om26er
reviewed
Dec 27, 2024
om26er
approved these changes
Dec 27, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.