Package org.webpieces.http2client.api

Interface Http2Socket

  • All Known Implementing Classes:
    Http2SocketImpl
    public interface Http2Socket

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.concurrent.CompletableFuture<java.lang.Void> close()  
      java.util.concurrent.CompletableFuture<java.lang.Void> connect​(java.net.InetSocketAddress addr)  
      com.webpieces.http2.api.streaming.RequestStreamHandle openStream()
      You should have a pretty good understanding the http/2 spec to use this method.
      java.util.concurrent.CompletableFuture<FullResponse> send​(FullRequest request)
      This can be used ONLY if 'you' know that the far end does NOT send a chunked download or in the case of http2, too large of a data download blowing your RAM.
      java.util.concurrent.CompletableFuture<java.lang.Void> sendPing()
      Future is complete when ping response is returned such that you can measure latency

    • Method Detail

      • connect

        java.util.concurrent.CompletableFuture<java.lang.Void> connect​(java.net.InetSocketAddress addr)

      • send

        java.util.concurrent.CompletableFuture<FullResponse> send​(FullRequest request)
        This can be used ONLY if 'you' know that the far end does NOT send a chunked download or in the case of http2, too large of a data download blowing your RAM. The reason is in a chunked download, we don't want to blow up your RAM. Some apis like twitters streaming api would never ever be done and have a full response. Others are just a very very large download you don't want existing in RAM anyways and you would rather receive a chunk, and write it to file or db, receive another and do the same to keep your RAM low.
        Parameters:
        request -

      • openStream

        com.webpieces.http2.api.streaming.RequestStreamHandle openStream()
        You should have a pretty good understanding the http/2 spec to use this method. This method supports EVERY use-case that http/2 has to offer (pretty much). Http1.1 and Http\2 are both a bit complex resulting in a more complex api IF you want to support all use-cases other than just the request/response use-case without blowing up your RAM including 1. send request headers only, then receive response headers and data chunks forever (twitter api does this) 2. send request headers only, then receive response headers and data chunks until end chunk is received -With this, you can stream chunks through your system so it works for very very large file use-cases without storing the whole file in RAM as you can stream it through the system 3. send request headers, then stream request chunks forever (this is sometimes a use-case) 4. send request headers and send data chunks, then receive response headers 5. send request headers and send data chunks, then receive response headers and data chunks
        Parameters:
        isComplete - true if you are only sending request headers with content-length = 0

      • close

        java.util.concurrent.CompletableFuture<java.lang.Void> close()

      • sendPing

        java.util.concurrent.CompletableFuture<java.lang.Void> sendPing()
        Future is complete when ping response is returned such that you can measure latency