DZone
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
Refcards Trend Reports
Events Video Library
Refcards
Trend Reports

Events

View Events Video Library

Zones

Culture and Methodologies Agile Career Development Methodologies Team Management
Data Engineering AI/ML Big Data Data Databases IoT
Software Design and Architecture Cloud Architecture Containers Integration Microservices Performance Security
Coding Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
Culture and Methodologies
Agile Career Development Methodologies Team Management
Data Engineering
AI/ML Big Data Data Databases IoT
Software Design and Architecture
Cloud Architecture Containers Integration Microservices Performance Security
Coding
Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance
Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks

How does AI transform chaos engineering from an experiment into a critical capability? Learn how to effectively operationalize the chaos.

Data quality isn't just a technical issue: It impacts an organization's compliance, operational efficiency, and customer satisfaction.

Are you a front-end or full-stack developer frustrated by front-end distractions? Learn to move forward with tooling and clear boundaries.

Developer Experience: Demand to support engineering teams has risen, and there is a shift from traditional DevOps to workflow improvements.

Related

  • How to Identify the Underlying Causes of Connection Timeout Errors for MongoDB With Java
  • Supercharge Your Java Apps With AI: A Practical Tutorial
  • How to Introduce a New API Quickly Using Micronaut
  • Building a Real-Time Audio Transcription System With OpenAI’s Realtime API

Trending

  • AI's Cognitive Cost: How Over-Reliance on AI Tools Impacts Critical Thinking
  • Multi-Cluster Networking With Kubernetes and Docker: Connecting Your Containerized Environment
  • CI/CD Metrics You Should Be Monitoring
  • The Truth About AI and Job Loss
  1. DZone
  2. Data Engineering
  3. Databases
  4. 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.

By 
Abhishek Gupta user avatar
Abhishek Gupta
DZone Core CORE ·
Dec. 10, 16 · Tutorial
Likes (4)
Comment
Save
Tweet
Share
12.0K 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.

Related

  • How to Identify the Underlying Causes of Connection Timeout Errors for MongoDB With Java
  • Supercharge Your Java Apps With AI: A Practical Tutorial
  • How to Introduce a New API Quickly Using Micronaut
  • Building a Real-Time Audio Transcription System With OpenAI’s Realtime API

Partner Resources

×

Comments

The likes didn't load as expected. Please refresh the page and try again.

ABOUT US

  • About DZone
  • Support and feedback
  • Community research
  • Sitemap

ADVERTISE

  • Advertise with DZone

CONTRIBUTE ON DZONE

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

LEGAL

  • Terms of Service
  • Privacy Policy

CONTACT US

  • 3343 Perimeter Hill Drive
  • Suite 100
  • Nashville, TN 37211
  • [email protected]

Let's be friends: