NetworkException
public
abstract
class
NetworkException
extends HttpException
java.lang.Object | |||||
↳ | java.lang.Throwable | ||||
↳ | java.lang.Exception | ||||
↳ | java.io.IOException | ||||
↳ | android.net.http.HttpException | ||||
↳ | android.net.http.NetworkException |
Exception passed to UrlRequest.Callback.onFailed()
when
the HTTP stack fails to process a network request. In this case getErrorCode()
can be used
to get more information about the specific type of failure.
Summary
Constants | |
---|---|
int |
ERROR_ADDRESS_UNREACHABLE
Error code indicating the IP address being contacted is unreachable, meaning there is no route to the specified host or network. |
int |
ERROR_CONNECTION_CLOSED
Error code indicating the connection was closed unexpectedly. |
int |
ERROR_CONNECTION_REFUSED
Error code indicating the connection attempt was refused. |
int |
ERROR_CONNECTION_RESET
Error code indicating the connection was unexpectedly reset. |
int |
ERROR_CONNECTION_TIMED_OUT
Error code indicating the connection attempt timed out. |
int |
ERROR_HOSTNAME_NOT_RESOLVED
Error code indicating the host being sent the request could not be resolved to an IP address. |
int |
ERROR_INTERNET_DISCONNECTED
Error code indicating the device was not connected to any network. |
int |
ERROR_NETWORK_CHANGED
Error code indicating that as the request was processed the network configuration changed. |
int |
ERROR_OTHER
Error code indicating another type of error was encountered. |
int |
ERROR_QUIC_PROTOCOL_FAILED
Error code indicating an error related to the QUIC protocol. |
int |
ERROR_TIMED_OUT
Error code indicating a timeout expired. |
Public constructors | |
---|---|
NetworkException(String message, Throwable cause)
Constructs an exception that is caused by a network error. |
Public methods | |
---|---|
abstract
int
|
getErrorCode()
Returns error code, one of |
abstract
boolean
|
isImmediatelyRetryable()
Returns |
Inherited methods | |
---|---|
Constants
ERROR_ADDRESS_UNREACHABLE
public static final int ERROR_ADDRESS_UNREACHABLE
Error code indicating the IP address being contacted is unreachable, meaning there is no route to the specified host or network.
Constant Value: 9 (0x00000009)
ERROR_CONNECTION_CLOSED
public static final int ERROR_CONNECTION_CLOSED
Error code indicating the connection was closed unexpectedly.
Constant Value: 5 (0x00000005)
ERROR_CONNECTION_REFUSED
public static final int ERROR_CONNECTION_REFUSED
Error code indicating the connection attempt was refused.
Constant Value: 7 (0x00000007)
ERROR_CONNECTION_RESET
public static final int ERROR_CONNECTION_RESET
Error code indicating the connection was unexpectedly reset.
Constant Value: 8 (0x00000008)
ERROR_CONNECTION_TIMED_OUT
public static final int ERROR_CONNECTION_TIMED_OUT
Error code indicating the connection attempt timed out.
Constant Value: 6 (0x00000006)
ERROR_HOSTNAME_NOT_RESOLVED
public static final int ERROR_HOSTNAME_NOT_RESOLVED
Error code indicating the host being sent the request could not be resolved to an IP address.
Constant Value: 1 (0x00000001)
ERROR_INTERNET_DISCONNECTED
public static final int ERROR_INTERNET_DISCONNECTED
Error code indicating the device was not connected to any network.
Constant Value: 2 (0x00000002)
ERROR_NETWORK_CHANGED
public static final int ERROR_NETWORK_CHANGED
Error code indicating that as the request was processed the network configuration changed.
When
getErrorCode()
returns this code, this exception may be cast to QuicException
for more information if QUIC protocol is used.
Constant Value: 3 (0x00000003)
ERROR_OTHER
public static final int ERROR_OTHER
Error code indicating another type of error was encountered.
Constant Value: 11 (0x0000000b)
ERROR_QUIC_PROTOCOL_FAILED
public static final int ERROR_QUIC_PROTOCOL_FAILED
Error code indicating an error related to the
QUIC protocol. When getErrorCode()
returns this code, this exception can be cast
to QuicException
for more information.
Constant Value: 10 (0x0000000a)
ERROR_TIMED_OUT
public static final int ERROR_TIMED_OUT
Error code indicating a timeout expired. Timeouts expiring while attempting to connect will
be reported as the more specific ERROR_CONNECTION_TIMED_OUT
.
Constant Value: 4 (0x00000004)
Public constructors
NetworkException
public NetworkException (String message, Throwable cause)
Constructs an exception that is caused by a network error.
Parameters | |
---|---|
message |
String : explanation of failure.
This value may be null . |
cause |
Throwable : the cause (which is saved for later retrieval by the getCause() method). A null value is permitted, and indicates
that the cause is nonexistent or unknown. |
Public methods
getErrorCode
public abstract int getErrorCode ()
Returns error code, one of ERROR_*
.
Returns | |
---|---|
int |
error code, one of ERROR_* . |
isImmediatelyRetryable
public abstract boolean isImmediatelyRetryable ()
Returns true
if retrying this request right away might succeed, false
otherwise. For example returns true
when getErrorCode()
returns ERROR_NETWORK_CHANGED
because trying the request might succeed using the new network
configuration, but false
when getErrorCode()
returns ERROR_INTERNET_DISCONNECTED
because retrying the request right away will encounter the same
failure (instead retrying should be delayed until device regains network connectivity).
Returns | |
---|---|
boolean |
true if retrying this request right away might succeed, false
otherwise. |