DZone
Integration Zone
Thanks for visiting DZone today,
Edit Profile
  • Manage Email Subscriptions
  • How to Post to DZone
  • Article Submission Guidelines
Sign Out View Profile
  • Post an Article
  • Manage My Drafts
Over 2 million developers have joined DZone.
Log In / Join
  • Refcardz
  • Trend Reports
  • Webinars
  • Zones
  • |
    • Agile
    • AI
    • Big Data
    • Cloud
    • Database
    • DevOps
    • Integration
    • IoT
    • Java
    • Microservices
    • Open Source
    • Performance
    • Security
    • Web Dev
DZone > Integration Zone > How to Use Asynchronous Timeouts in the Java Websocket API

How to Use Asynchronous Timeouts in the Java Websocket API

In this post we take a look at how to deal with timeouts when using the Java WebSocket API. Read on to find out how and for some example code.

Abhishek Gupta user avatar by
Abhishek Gupta
CORE ·
Dec. 10, 16 · Integration Zone · Tutorial
Like (4)
Save
Tweet
10.60K Views

Join the DZone community and get the full member experience.

Join For Free

Sending messages in an asynchronous manner avoids blocking the sending thread. This is great when your solution needs to scale in order to support a large number of clients, but there is a limit on how long can we wait for the asynchronous process to complete.

The Java WebSocket API gives you a few options in this regard.

Async Timeout Support

  • First and foremost, there is a notion of a timeout. This can be configured using the setSendTimeout method in the RemoteEndpoint.Async interface.
  • Secondly, the failure result manifests itself using the Future object or java.websocket.SendResult.

How Do Timeouts Manifest?

It depends on which strategy you’re using in order to send your messages:

  • Callback-based.
  • Future-based.

In case you are using the java.websocket.SendHandler, i.e. the callback handler route, the timeout exception details will be available via SendResult.getException(). 

....
public void broadcast(Session s, String msg){
  RemoteEndpoint asyncHandle = s.getRemoteAsync();
  asyncHandle.setSendTimeout(1000); //1 second
  asyncHandle.sendText(msg, 
    new SendHandler(){
      @Override
        public void onResult(SendResult result) {
        if(!result.isOK()){
        System.out.println("Async send failure: "+ result.getException());
        }
    }
  }); //will timeout after 2 seconds
  tracker.get(); //will throw java.util.ExecutionException if the process had timed out
}
....

If you chose to use the Future to track the completion, calling it get method will result in a java.util.concurrent.ExecutionException.

....
public void broadcast(Session s, String msg){
  RemoteEndpoint asyncHandle = s.getRemoteAsync();
  asyncHandle.setSendTimeout(2000); //2000 ms
  Future<Void> tracker = asyncHandle.sendText(msg); //will timeout after 2 seconds
  tracker.get(); //will throw java.util.ExecutionException if the process had timed out
}
....

Further Reading

  • Java WebSocket API specification.
  • Other WebSocket blogs.
API Timeout (computing) WebSocket Java (programming language)

Published at DZone with permission of Abhishek Gupta, DZone MVB. See the original article here.

Opinions expressed by DZone contributors are their own.

Popular on DZone

  • SQL CTE: How to Master It in One Sitting With Easy Examples
  • Why You Should Stop Relying on Jenkins Plug-ins
  • Instancio: Test Data Generator for Java (Part 2)
  • Progressive Web Apps vs Native Apps: Differences and Similarities

Comments

Integration Partner Resources

X

ABOUT US

  • About DZone
  • Send feedback
  • Careers
  • Sitemap

ADVERTISE

  • Advertise with DZone

CONTRIBUTE ON DZONE

  • Article Submission Guidelines
  • MVB Program
  • Become a Contributor
  • Visit the Writers' Zone

LEGAL

  • Terms of Service
  • Privacy Policy

CONTACT US

  • 600 Park Offices Drive
  • Suite 300
  • Durham, NC 27709
  • support@dzone.com
  • +1 (919) 678-0300

Let's be friends:

DZone.com is powered by 

AnswerHub logo