WebSocketResponseImpl (RxJava Javadoc 0.5.2-RC1)

java.lang.Object
- io.reactivex.netty.protocol.http.client.HttpClientResponse<T>
- - io.reactivex.netty.protocol.http.ws.client.WebSocketResponse<T>
  - - io.reactivex.netty.protocol.http.ws.client.internal.WebSocketResponseImpl<T>

public final class WebSocketResponseImpl<T>
extends WebSocketResponse<T>

Constructor Summary

Constructors
Constructor and Description

WebSocketResponseImpl(HttpClientResponse<T> delegate)

Constructors
Constructor and Description
`WebSocketResponseImpl(HttpClientResponse<T> delegate)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpClientResponse<T>`	`addCookie(io.netty.handler.codec.http.cookie.Cookie cookie)` Adds the passed `cookie` to this response.
`HttpClientResponse<T>`	`addDateHeader(java.lang.CharSequence name, java.util.Date value)` Adds the passed header as a date value to this response.
`HttpClientResponse<T>`	`addDateHeader(java.lang.CharSequence name, java.lang.Iterable<java.util.Date> values)` Adds multiple date values for the passed header name to this response.
`HttpClientResponse<T>`	`addHeader(java.lang.CharSequence name, java.lang.Iterable<java.lang.Object> values)` Adds an HTTP header with the passed `name` and `values` to this response.
`HttpClientResponse<T>`	`addHeader(java.lang.CharSequence name, java.lang.Object value)` Adds an HTTP header with the passed `name` and `value` to this response.
`boolean`	`containsHeader(java.lang.CharSequence name)` Checks if there is a header with the passed name in this response.
`boolean`	`containsHeader(java.lang.CharSequence name, java.lang.CharSequence value, boolean ignoreCaseValue)` Checks if there is a header with the passed name and value in this response.
`rx.Observable<java.lang.Void>`	`discardContent()` Marks the content to be discarded.
`java.util.List<java.lang.String>`	`getAllHeaderValues(java.lang.CharSequence name)` Returns the values of headers with the specified name
`io.reactivex.netty.channel.ContentSource<T>`	`getContent()` Returns the content as a stream.
`io.reactivex.netty.channel.ContentSource<ServerSentEvent>`	`getContentAsServerSentEvents()` Returns the content as a stream of Server sent events.
`long`	`getContentLength()` Returns the length of the content.
`long`	`getContentLength(long defaultValue)` Returns the length of the content.
`java.util.Map<java.lang.String,java.util.Set<io.netty.handler.codec.http.cookie.Cookie>>`	`getCookies()` Returns an immutable map of cookie names and cookies contained in this response.
`long`	`getDateHeader(java.lang.CharSequence name)` Returns the date header value with the specified header name.
`long`	`getDateHeader(java.lang.CharSequence name, long defaultValue)` Returns the date header value with the specified header name.
`java.lang.String`	`getHeader(java.lang.CharSequence name)` Returns the value of a header with the specified name.
`java.lang.String`	`getHeader(java.lang.CharSequence name, java.lang.String defaultValue)` Returns the value of a header with the specified name.
`java.util.Set<java.lang.String>`	`getHeaderNames()` Returns a new `Set` that contains the names of all headers in this response.
`java.lang.String`	`getHost(java.lang.String defaultValue)` Returns the value of the `"Host"` header.
`java.lang.String`	`getHostHeader()` Returns the value of the `"Host"` header.
`io.netty.handler.codec.http.HttpVersion`	`getHttpVersion()` Returns the HTTP version for this response.
`int`	`getIntHeader(java.lang.CharSequence name)` Returns the integer header value with the specified header name.
`int`	`getIntHeader(java.lang.CharSequence name, int defaultValue)` Returns the integer header value with the specified header name.
`io.netty.handler.codec.http.HttpResponseStatus`	`getStatus()` Returns the HTTP status for this response.
`rx.Observable<WebSocketConnection>`	`getWebSocketConnection()`
`java.util.Iterator<java.util.Map.Entry<java.lang.CharSequence,java.lang.CharSequence>>`	`headerIterator()` Returns an iterator over the header entries.
`boolean`	`isContentLengthSet()` Returns `true` if and only if this response has the content-length header set.
`boolean`	`isKeepAlive()` Returns `true` if and only if the connection can remain open and thus 'kept alive'.
`boolean`	`isTransferEncodingChunked()` Checks to see if the transfer encoding of this response is chunked
`HttpClientResponse<T>`	`removeHeader(java.lang.CharSequence name)` Removes the passed header from this response.
`HttpClientResponse<T>`	`setDateHeader(java.lang.CharSequence name, java.util.Date value)` Overwrites the current value, if any, of the passed header to the passed date value for this response.
`HttpClientResponse<T>`	`setDateHeader(java.lang.CharSequence name, java.lang.Iterable<java.util.Date> values)` Overwrites the current value, if any, of the passed header to the passed date values for this response.
`HttpClientResponse<T>`	`setHeader(java.lang.CharSequence name, java.lang.Iterable<java.lang.Object> values)` Overwrites the current value, if any, of the passed header to the passed values for this response.
`HttpClientResponse<T>`	`setHeader(java.lang.CharSequence name, java.lang.Object value)` Overwrites the current value, if any, of the passed header to the passed value for this response.
`java.lang.String`	`toString()`
`<TT> HttpClientResponse<TT>`	`transformContent(rx.Observable.Transformer<T,TT> transformer)` Transforms the type of objects read from the content of this response, using the supplied `transformer`.
`io.reactivex.netty.channel.Connection<?,?>`	`unsafeConnection()` Returns the underlying connection on which this response was received.
`io.netty.channel.Channel`	`unsafeNettyChannel()` Returns the underlying channel on which this response was received.

Methods inherited from class io.reactivex.netty.protocol.http.ws.client.WebSocketResponse
getAcceptedSubProtocol, isUpgraded

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - WebSocketResponseImpl
```
public WebSocketResponseImpl(HttpClientResponse<T> delegate)
```
- Method Detail
  - getWebSocketConnection
```
public rx.Observable<WebSocketConnection> getWebSocketConnection()
```
    Specified by:
    
    getWebSocketConnection in class WebSocketResponse<T>
  - getHttpVersion
```
public io.netty.handler.codec.http.HttpVersion getHttpVersion()
```
    Description copied from class: HttpClientResponse
    
    Returns the HTTP version for this response.
    
    Specified by:
    
    getHttpVersion in class HttpClientResponse<T>
    
    Returns:
    
    The HTTP version for this response.
  - getStatus
```
public io.netty.handler.codec.http.HttpResponseStatus getStatus()
```
    Description copied from class: HttpClientResponse
    
    Returns the HTTP status for this response.
    
    Specified by:
    
    getStatus in class HttpClientResponse<T>
    
    Returns:
    
    The HTTP status for this response.
  - getCookies
```
public java.util.Map<java.lang.String,java.util.Set<io.netty.handler.codec.http.cookie.Cookie>> getCookies()
```
    Description copied from class: HttpClientResponse
    
    Returns an immutable map of cookie names and cookies contained in this response.
    
    Specified by:
    
    getCookies in class HttpClientResponse<T>
    
    Returns:
    
    An immutable map of cookie names and cookies contained in this response.
  - containsHeader
```
public boolean containsHeader(java.lang.CharSequence name)
```
    Description copied from class: HttpClientResponse
    
    Checks if there is a header with the passed name in this response.
    
    Specified by:
    
    containsHeader in class HttpClientResponse<T>
    
    Parameters:
    
    name - Name of the header.
    
    Returns:
    
    true if there is a header with the passed name in this response.
  - containsHeader
```
public boolean containsHeader(java.lang.CharSequence name,
                              java.lang.CharSequence value,
                              boolean ignoreCaseValue)
```
    Description copied from class: HttpClientResponse
    
    Checks if there is a header with the passed name and value in this response.
    
    Specified by:
    
    containsHeader in class HttpClientResponse<T>
    
    Parameters:
    
    name - Name of the header.
    
    value - Value of the header.
    
    ignoreCaseValue - true then the value comparision is done ignoring case.
    
    Returns:
    
    true if there is a header with the passed name and value in this response.
  - headerIterator
```
public java.util.Iterator<java.util.Map.Entry<java.lang.CharSequence,java.lang.CharSequence>> headerIterator()
```
    Description copied from class: HttpClientResponse
    
    Returns an iterator over the header entries. Multiple values for the same header appear as separate entries in the returned iterator.
    
    Specified by:
    
    headerIterator in class HttpClientResponse<T>
    
    Returns:
    
    An iterator over the header entries
  - getHeader
```
public java.lang.String getHeader(java.lang.CharSequence name)
```
    Description copied from class: HttpClientResponse
    
    Returns the value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.
    
    Specified by:
    
    getHeader in class HttpClientResponse<T>
    
    Parameters:
    
    name - The name of the header to search
    
    Returns:
    
    The first header value or null if there is no such header
  - getHeader
```
public java.lang.String getHeader(java.lang.CharSequence name,
                                  java.lang.String defaultValue)
```
    Description copied from class: HttpClientResponse
    
    Returns the value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.
    
    Specified by:
    
    getHeader in class HttpClientResponse<T>
    
    Parameters:
    
    name - The name of the header to search
    
    defaultValue - Default if the header does not exist.
    
    Returns:
    
    The first header value or defaultValue if there is no such header
  - getAllHeaderValues
```
public java.util.List<java.lang.String> getAllHeaderValues(java.lang.CharSequence name)
```
    Description copied from class: HttpClientResponse
    
    Returns the values of headers with the specified name
    
    Specified by:
    
    getAllHeaderValues in class HttpClientResponse<T>
    
    Parameters:
    
    name - The name of the headers to search
    
    Returns:
    
    A List of header values which will be empty if no values are found
  - getContentLength
```
public long getContentLength()
```
    Description copied from class: HttpClientResponse
    
    Returns the length of the content.
    
    Specified by:
    
    getContentLength in class HttpClientResponse<T>
    
    Returns:
    
    the content length
  - getContentLength
```
public long getContentLength(long defaultValue)
```
    Description copied from class: HttpClientResponse
    
    Returns the length of the content.
    
    Specified by:
    
    getContentLength in class HttpClientResponse<T>
    
    Parameters:
    
    defaultValue - Default value if the message does not have a "Content-Length" header or its value is not a number
    
    Returns:
    
    the content length or defaultValue if this message does not have the "Content-Length" header or its value is not a number
  - getDateHeader
```
public long getDateHeader(java.lang.CharSequence name)
                   throws java.text.ParseException
```
    Description copied from class: HttpClientResponse
    Returns the date header value with the specified header name. If there are more than one header value for the specified header name, the first value is returned. The value is parsed as per the HTTP specifications using the format:
```
"E, dd MMM yyyy HH:mm:ss z"
```
    Specified by:
    
    getDateHeader in class HttpClientResponse<T>
    
    Parameters:
    
    name - The name of the header to search
    
    Returns:
    
    the header value
    
    Throws:
    
    java.text.ParseException - if there is no such header or the header value is not a formatted date
  - getDateHeader
```
public long getDateHeader(java.lang.CharSequence name,
                          long defaultValue)
```
    Description copied from class: HttpClientResponse
    Returns the date header value with the specified header name. If there are more than one header value for the specified header name, the first value is returned. The value is parsed as per the HTTP specifications using the format:
```
"E, dd MMM yyyy HH:mm:ss z"
```
    Specified by:
    
    getDateHeader in class HttpClientResponse<T>
    
    Parameters:
    
    name - The name of the header to search
    
    defaultValue - Default value if there is no header with this name.
    
    Returns:
    
    the header value or defaultValue if there is no header with this name.
  - getHostHeader
```
public java.lang.String getHostHeader()
```
    Description copied from class: HttpClientResponse
    
    Returns the value of the "Host" header.
    
    Specified by:
    
    getHostHeader in class HttpClientResponse<T>
  - getHost
```
public java.lang.String getHost(java.lang.String defaultValue)
```
    Description copied from class: HttpClientResponse
    
    Returns the value of the "Host" header.
    
    Specified by:
    
    getHost in class HttpClientResponse<T>
    
    Parameters:
    
    defaultValue - Default if the header does not exist.
    
    Returns:
    
    The value of the "Host" header or defaultValue if there is no such header.
  - getIntHeader
```
public int getIntHeader(java.lang.CharSequence name)
```
    Description copied from class: HttpClientResponse
    
    Returns the integer header value with the specified header name. If there are more than one header value for the specified header name, the first value is returned.
    
    Specified by:
    
    getIntHeader in class HttpClientResponse<T>
    
    Parameters:
    
    name - The name of the header to search
    
    Returns:
    
    the header value
  - getIntHeader
```
public int getIntHeader(java.lang.CharSequence name,
                        int defaultValue)
```
    Description copied from class: HttpClientResponse
    
    Returns the integer header value with the specified header name. If there are more than one header value for the specified header name, the first value is returned.
    
    Specified by:
    
    getIntHeader in class HttpClientResponse<T>
    
    Parameters:
    
    name - The name of the header to search
    
    defaultValue - Default if the header does not exist.
    
    Returns:
    
    the header value or the defaultValue if there is no such header or the header value is not a number
  - isContentLengthSet
```
public boolean isContentLengthSet()
```
    Description copied from class: HttpClientResponse
    
    Returns true if and only if this response has the content-length header set.
    
    Specified by:
    
    isContentLengthSet in class HttpClientResponse<T>
  - isKeepAlive
```
public boolean isKeepAlive()
```
    Description copied from class: HttpClientResponse
    
    Returns true if and only if the connection can remain open and thus 'kept alive'. This methods respects the value of the "Connection" header first and then the return value of HttpVersion.isKeepAliveDefault().
    
    Specified by:
    
    isKeepAlive in class HttpClientResponse<T>
  - isTransferEncodingChunked
```
public boolean isTransferEncodingChunked()
```
    Description copied from class: HttpClientResponse
    
    Checks to see if the transfer encoding of this response is chunked
    
    Specified by:
    
    isTransferEncodingChunked in class HttpClientResponse<T>
    
    Returns:
    
    True if transfer encoding is chunked, otherwise false
  - getHeaderNames
```
public java.util.Set<java.lang.String> getHeaderNames()
```
    Description copied from class: HttpClientResponse
    
    Returns a new Set that contains the names of all headers in this response. Note that modifying the returned Set will not affect the state of this response.
    
    Specified by:
    
    getHeaderNames in class HttpClientResponse<T>
  - addHeader
```
public HttpClientResponse<T> addHeader(java.lang.CharSequence name,
                                       java.lang.Object value)
```
    Description copied from class: HttpClientResponse
    
    Adds an HTTP header with the passed name and value to this response.
    
    Specified by:
    
    addHeader in class HttpClientResponse<T>
    
    Parameters:
    
    name - Name of the header.
    
    value - Value for the header.
    
    Returns:
    
    this
  - addCookie
```
public HttpClientResponse<T> addCookie(io.netty.handler.codec.http.cookie.Cookie cookie)
```
    Description copied from class: HttpClientResponse
    
    Adds the passed cookie to this response.
    
    Specified by:
    
    addCookie in class HttpClientResponse<T>
    
    Parameters:
    
    cookie - Cookie to add.
    
    Returns:
    
    this
  - addDateHeader
```
public HttpClientResponse<T> addDateHeader(java.lang.CharSequence name,
                                           java.util.Date value)
```
    Description copied from class: HttpClientResponse
    Adds the passed header as a date value to this response. The date is formatted using netty's HttpHeaders.addDateHeader(HttpMessage, CharSequence, Date) which formats the date as per the HTTP specifications into the format:
```
"E, dd MMM yyyy HH:mm:ss z"
```
    Specified by:
    
    addDateHeader in class HttpClientResponse<T>
    
    Parameters:
    
    name - Name of the header.
    
    value - Value of the header.
    
    Returns:
    
    this
  - addDateHeader
```
public HttpClientResponse<T> addDateHeader(java.lang.CharSequence name,
                                           java.lang.Iterable<java.util.Date> values)
```
    Description copied from class: HttpClientResponse
    Adds multiple date values for the passed header name to this response. The date values are formatted using netty's HttpHeaders.addDateHeader(HttpMessage, CharSequence, Date) which formats the date as per the HTTP specifications into the format:
```
"E, dd MMM yyyy HH:mm:ss z"
```
    Specified by:
    
    addDateHeader in class HttpClientResponse<T>
    
    Parameters:
    
    name - Name of the header.
    
    values - Values for the header.
    
    Returns:
    
    this
  - addHeader
```
public HttpClientResponse<T> addHeader(java.lang.CharSequence name,
                                       java.lang.Iterable<java.lang.Object> values)
```
    Description copied from class: HttpClientResponse
    
    Adds an HTTP header with the passed name and values to this response.
    
    Specified by:
    
    addHeader in class HttpClientResponse<T>
    
    Parameters:
    
    name - Name of the header.
    
    values - Values for the header.
    
    Returns:
    
    this
  - setDateHeader
```
public HttpClientResponse<T> setDateHeader(java.lang.CharSequence name,
                                           java.util.Date value)
```
    Description copied from class: HttpClientResponse
    Overwrites the current value, if any, of the passed header to the passed date value for this response. The date is formatted using netty's HttpHeaders.addDateHeader(HttpMessage, CharSequence, Date) which formats the date as per the HTTP specifications into the format:
```
"E, dd MMM yyyy HH:mm:ss z"
```
    Specified by:
    
    setDateHeader in class HttpClientResponse<T>
    
    Parameters:
    
    name - Name of the header.
    
    value - Value of the header.
    
    Returns:
    
    this
  - setHeader
```
public HttpClientResponse<T> setHeader(java.lang.CharSequence name,
                                       java.lang.Object value)
```
    Description copied from class: HttpClientResponse
    
    Overwrites the current value, if any, of the passed header to the passed value for this response.
    
    Specified by:
    
    setHeader in class HttpClientResponse<T>
    
    Parameters:
    
    name - Name of the header.
    
    value - Value of the header.
    
    Returns:
    
    this
  - setDateHeader
```
public HttpClientResponse<T> setDateHeader(java.lang.CharSequence name,
                                           java.lang.Iterable<java.util.Date> values)
```
    Description copied from class: HttpClientResponse
    Overwrites the current value, if any, of the passed header to the passed date values for this response. The date is formatted using netty's HttpHeaders.addDateHeader(HttpMessage, CharSequence, Date) which formats the date as per the HTTP specifications into the format:
```
"E, dd MMM yyyy HH:mm:ss z"
```
    Specified by:
    
    setDateHeader in class HttpClientResponse<T>
    
    Parameters:
    
    name - Name of the header.
    
    values - Values of the header.
    
    Returns:
    
    this
  - setHeader
```
public HttpClientResponse<T> setHeader(java.lang.CharSequence name,
                                       java.lang.Iterable<java.lang.Object> values)
```
    Description copied from class: HttpClientResponse
    
    Overwrites the current value, if any, of the passed header to the passed values for this response.
    
    Specified by:
    
    setHeader in class HttpClientResponse<T>
    
    Parameters:
    
    name - Name of the header.
    
    values - Values of the header.
    
    Returns:
    
    this
  - removeHeader
```
public HttpClientResponse<T> removeHeader(java.lang.CharSequence name)
```
    Description copied from class: HttpClientResponse
    
    Removes the passed header from this response.
    
    Specified by:
    
    removeHeader in class HttpClientResponse<T>
    
    Parameters:
    
    name - Name of the header.
    
    Returns:
    
    this
  - getContentAsServerSentEvents
```
public io.reactivex.netty.channel.ContentSource<ServerSentEvent> getContentAsServerSentEvents()
```
    Description copied from class: HttpClientResponse
    
    Returns the content as a stream of Server sent events. There can only be one Subscriber to the returned Observable, any subsequent subscriptions will get an error.
    
    Specified by:
    
    getContentAsServerSentEvents in class HttpClientResponse<T>
    
    Returns:
    
    Stream of content as ServerSentEvent messages.
  - getContent
```
public io.reactivex.netty.channel.ContentSource<T> getContent()
```
    Description copied from class: HttpClientResponse
    
    Returns the content as a stream. There can only be one Subscriber to the returned Observable, any subsequent subscriptions will get an error.
    
    Specified by:
    
    getContent in class HttpClientResponse<T>
    
    Returns:
    
    Stream of content.
  - discardContent
```
public rx.Observable<java.lang.Void> discardContent()
```
    Description copied from class: HttpClientResponse
    
    Marks the content to be discarded. This means that the content can not be read from this response from now.
    
    Specified by:
    
    discardContent in class HttpClientResponse<T>
    
    Returns:
    
    An Observable, subscription to which will discard the content. This Observable will error/complete when the content errors/completes and unsubscription from here will unsubscribe from the content.
  - transformContent
```
public <TT> HttpClientResponse<TT> transformContent(rx.Observable.Transformer<T,TT> transformer)
```
    Description copied from class: HttpClientResponse
    
    Transforms the type of objects read from the content of this response, using the supplied transformer.
    
    Specified by:
    
    transformContent in class HttpClientResponse<T>
    
    Returns:
    
    A new instance of HttpClientResponse with transformed content.
  - unsafeNettyChannel
```
public io.netty.channel.Channel unsafeNettyChannel()
```
    Description copied from class: HttpClientResponse
    
    Returns the underlying channel on which this response was received.
    
    Specified by:
    
    unsafeNettyChannel in class HttpClientResponse<T>
    
    Returns:
    
    The underlying channel on which this response was received.
  - unsafeConnection
```
public io.reactivex.netty.channel.Connection<?,?> unsafeConnection()
```
    Description copied from class: HttpClientResponse
    
    Returns the underlying connection on which this response was received.
    
    Specified by:
    
    unsafeConnection in class HttpClientResponse<T>
    
    Returns:
    
    The underlying connection on which this response was received.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class HttpClientResponse<T>

RxJava

Class WebSocketResponseImpl<T>

Constructor Summary

Method Summary

Methods inherited from class io.reactivex.netty.protocol.http.ws.client.WebSocketResponse

Methods inherited from class java.lang.Object

Constructor Detail

WebSocketResponseImpl

Method Detail

getWebSocketConnection

getHttpVersion

getStatus

getCookies

containsHeader

containsHeader

headerIterator

getHeader

getHeader

getAllHeaderValues

getContentLength

getContentLength

getDateHeader

getDateHeader

getHostHeader

getHost

getIntHeader

getIntHeader

isContentLengthSet

isKeepAlive

isTransferEncodingChunked

getHeaderNames

addHeader

addCookie

addDateHeader

addDateHeader

addHeader

setDateHeader

setHeader

setDateHeader

setHeader

removeHeader

getContentAsServerSentEvents

getContent

discardContent

transformContent

unsafeNettyChannel

unsafeConnection

toString