io.vertx.core.http.HttpClientResponse Maven / Gradle / Ivy
/*
* Copyright (c) 2011-2013 The original author or authors
* ------------------------------------------------------
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* and Apache License v2.0 which accompanies this distribution.
*
* The Eclipse Public License is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* The Apache License v2.0 is available at
* http://www.opensource.org/licenses/apache2.0.php
*
* You may elect to redistribute this code under either of these licenses.
*/
package io.vertx.core.http;
import io.vertx.codegen.annotations.CacheReturn;
import io.vertx.codegen.annotations.Fluent;
import io.vertx.codegen.annotations.GenIgnore;
import io.vertx.codegen.annotations.Nullable;
import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.Handler;
import io.vertx.core.MultiMap;
import io.vertx.core.buffer.Buffer;
import io.vertx.core.net.NetSocket;
import io.vertx.core.streams.ReadStream;
import java.util.List;
/**
* Represents a client-side HTTP response.
*
* Vert.x provides you with one of these via the handler that was provided when creating the {@link io.vertx.core.http.HttpClientRequest}
* or that was set on the {@link io.vertx.core.http.HttpClientRequest} instance.
*
* It implements {@link io.vertx.core.streams.ReadStream} so it can be used with
* {@link io.vertx.core.streams.Pump} to pump data with flow control.
*
* @author Tim Fox
*/
@VertxGen
public interface HttpClientResponse extends ReadStream {
@Override
HttpClientResponse resume();
@Override
HttpClientResponse exceptionHandler(Handler handler);
@Override
HttpClientResponse handler(Handler handler);
@Override
HttpClientResponse pause();
@Override
HttpClientResponse endHandler(Handler endHandler);
/**
* @return the status code of the response
*/
int statusCode();
/**
* @return the status message of the response
*/
String statusMessage();
/**
* @return the headers
*/
@CacheReturn
MultiMap headers();
/**
* Return the first header value with the specified name
*
* @param headerName the header name
* @return the header value
*/
@Nullable String getHeader(String headerName);
/**
* Return the first header value with the specified name
*
* @param headerName the header name
* @return the header value
*/
@GenIgnore
String getHeader(CharSequence headerName);
/**
* Return the first trailer value with the specified name
*
* @param trailerName the trailer name
* @return the trailer value
*/
@Nullable String getTrailer(String trailerName);
/**
* @return the trailers
*/
@CacheReturn
MultiMap trailers();
/**
* @return the Set-Cookie headers (including trailers)
*/
@CacheReturn
List cookies();
/**
* Convenience method for receiving the entire request body in one piece.
*
* This saves you having to manually set a dataHandler and an endHandler and append the chunks of the body until
* the whole body received. Don't use this if your request body is large - you could potentially run out of RAM.
*
* @param bodyHandler This handler will be called after all the body has been received
*/
@Fluent
HttpClientResponse bodyHandler(Handler bodyHandler);
/**
* Get a net socket for the underlying connection of this request.
*
* USE THIS WITH CAUTION! Writing to the socket directly if you don't know what you're doing can easily break the HTTP protocol
*
* One valid use-case for calling this is to receive the {@link io.vertx.core.net.NetSocket} after a HTTP CONNECT was issued to the
* remote peer and it responded with a status code of 200.
*
* @return the net socket
*/
@CacheReturn
NetSocket netSocket();
}