Use websocket pings

This commit is contained in:
Adam
2019-01-27 15:21:45 -05:00
parent 703ad06a4e
commit 63c3937f87
4 changed files with 4 additions and 71 deletions

View File

@@ -28,6 +28,7 @@ import com.google.gson.Gson;
import java.io.IOException; import java.io.IOException;
import java.io.InputStream; import java.io.InputStream;
import java.util.Properties; import java.util.Properties;
import java.util.concurrent.TimeUnit;
import okhttp3.HttpUrl; import okhttp3.HttpUrl;
import okhttp3.Interceptor; import okhttp3.Interceptor;
import okhttp3.OkHttpClient; import okhttp3.OkHttpClient;
@@ -77,6 +78,7 @@ public class RuneLiteAPI
} }
CLIENT = new OkHttpClient.Builder() CLIENT = new OkHttpClient.Builder()
.pingInterval(30, TimeUnit.SECONDS)
.addNetworkInterceptor(new Interceptor() .addNetworkInterceptor(new Interceptor()
{ {

View File

@@ -32,7 +32,6 @@ import java.util.Collections;
import java.util.List; import java.util.List;
import net.runelite.http.api.ws.messages.Handshake; import net.runelite.http.api.ws.messages.Handshake;
import net.runelite.http.api.ws.messages.LoginResponse; import net.runelite.http.api.ws.messages.LoginResponse;
import net.runelite.http.api.ws.messages.Ping;
import net.runelite.http.api.ws.messages.party.Join; import net.runelite.http.api.ws.messages.party.Join;
import net.runelite.http.api.ws.messages.party.Part; import net.runelite.http.api.ws.messages.party.Part;
import net.runelite.http.api.ws.messages.party.UserJoin; import net.runelite.http.api.ws.messages.party.UserJoin;
@@ -48,7 +47,6 @@ public class WebsocketGsonFactory
final List<Class<? extends WebsocketMessage>> messages = new ArrayList<>(); final List<Class<? extends WebsocketMessage>> messages = new ArrayList<>();
messages.add(Handshake.class); messages.add(Handshake.class);
messages.add(LoginResponse.class); messages.add(LoginResponse.class);
messages.add(Ping.class);
messages.add(Join.class); messages.add(Join.class);
messages.add(Part.class); messages.add(Part.class);
messages.add(UserJoin.class); messages.add(UserJoin.class);

View File

@@ -1,43 +0,0 @@
/*
* Copyright (c) 2017, Adam <Adam@sigterm.info>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package net.runelite.http.api.ws.messages;
import java.time.Instant;
import net.runelite.http.api.ws.WebsocketMessage;
public class Ping extends WebsocketMessage
{
private Instant time;
public Instant getTime()
{
return time;
}
public void setTime(Instant time)
{
this.time = time;
}
}

View File

@@ -26,14 +26,10 @@ package net.runelite.client.ws;
import com.google.gson.Gson; import com.google.gson.Gson;
import java.time.Duration; import java.time.Duration;
import java.time.Instant;
import java.util.Collection; import java.util.Collection;
import java.util.HashSet; import java.util.HashSet;
import java.util.Objects; import java.util.Objects;
import java.util.UUID; import java.util.UUID;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.ScheduledFuture;
import java.util.concurrent.TimeUnit;
import javax.inject.Inject; import javax.inject.Inject;
import javax.inject.Singleton; import javax.inject.Singleton;
import lombok.extern.slf4j.Slf4j; import lombok.extern.slf4j.Slf4j;
@@ -42,9 +38,7 @@ import net.runelite.http.api.RuneLiteAPI;
import net.runelite.http.api.ws.WebsocketGsonFactory; import net.runelite.http.api.ws.WebsocketGsonFactory;
import net.runelite.http.api.ws.WebsocketMessage; import net.runelite.http.api.ws.WebsocketMessage;
import net.runelite.http.api.ws.messages.Handshake; import net.runelite.http.api.ws.messages.Handshake;
import net.runelite.http.api.ws.messages.Ping;
import net.runelite.http.api.ws.messages.party.PartyMessage; import net.runelite.http.api.ws.messages.party.PartyMessage;
import okhttp3.OkHttpClient;
import okhttp3.Request; import okhttp3.Request;
import okhttp3.Response; import okhttp3.Response;
import okhttp3.WebSocket; import okhttp3.WebSocket;
@@ -54,11 +48,7 @@ import okhttp3.WebSocketListener;
@Singleton @Singleton
public class WSClient extends WebSocketListener implements AutoCloseable public class WSClient extends WebSocketListener implements AutoCloseable
{ {
private static final Duration PING_TIME = Duration.ofSeconds(30);
private final OkHttpClient client = new OkHttpClient();
private final EventBus eventBus; private final EventBus eventBus;
private final ScheduledFuture pingFuture;
private final Collection<Class<? extends WebsocketMessage>> messages = new HashSet<>(); private final Collection<Class<? extends WebsocketMessage>> messages = new HashSet<>();
private volatile Gson gson; private volatile Gson gson;
@@ -66,10 +56,9 @@ public class WSClient extends WebSocketListener implements AutoCloseable
private WebSocket webSocket; private WebSocket webSocket;
@Inject @Inject
private WSClient(EventBus eventBus, ScheduledExecutorService executor) private WSClient(EventBus eventBus)
{ {
this.eventBus = eventBus; this.eventBus = eventBus;
this.pingFuture = executor.scheduleWithFixedDelay(this::ping, PING_TIME.getSeconds(), PING_TIME.getSeconds(), TimeUnit.SECONDS);
this.gson = WebsocketGsonFactory.build(WebsocketGsonFactory.factory(messages)); this.gson = WebsocketGsonFactory.build(WebsocketGsonFactory.factory(messages));
} }
@@ -110,26 +99,13 @@ public class WSClient extends WebSocketListener implements AutoCloseable
.url(RuneLiteAPI.getWsEndpoint()) .url(RuneLiteAPI.getWsEndpoint())
.build(); .build();
webSocket = client.newWebSocket(request, this); webSocket = RuneLiteAPI.CLIENT.newWebSocket(request, this);
Handshake handshake = new Handshake(); Handshake handshake = new Handshake();
handshake.setSession(sessionId); handshake.setSession(sessionId);
send(handshake); send(handshake);
} }
private void ping()
{
if (webSocket == null)
{
// Don't open a socket just for ping.
return;
}
Ping ping = new Ping();
ping.setTime(Instant.now());
send(ping);
}
public void registerMessage(final Class<? extends WebsocketMessage> message) public void registerMessage(final Class<? extends WebsocketMessage> message)
{ {
if (messages.add(message)) if (messages.add(message))