SocketPolicy (MockWebServer 3.4.2 API)

java.lang.Object
- java.lang.Enum<SocketPolicy>
- - okhttp3.mockwebserver.SocketPolicy

All Implemented Interfaces:

Serializable, Comparable<SocketPolicy>
```
public enum SocketPolicy
extends Enum<SocketPolicy>
```
What should be done with the incoming socket.
Be careful when using values like DISCONNECT_AT_END, SHUTDOWN_INPUT_AT_END and SHUTDOWN_OUTPUT_AT_END that close a socket after a response, and where there are follow-up requests. The client is unblocked and free to continue as soon as it has received the entire response body. If and when the client makes a subsequent request using a pooled socket the server may not have had time to close the socket. The socket will be closed at an indeterminate point before or during the second request. It may be closed after client has started sending the request body. If a request body is not retryable then the client may fail the request, making client behavior non-deterministic. Add delays in the client to improve the chances that the server has closed the socket before follow up requests are made.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`DISCONNECT_AFTER_REQUEST` Close connection after reading the request but before writing the response.
`DISCONNECT_AT_END` Close the socket after the response.
`DISCONNECT_AT_START` Request immediate close of connection without even reading the request.
`DISCONNECT_DURING_REQUEST_BODY` Close connection after reading half of the request body (if present).
`DISCONNECT_DURING_RESPONSE_BODY` Close connection after writing half of the response body (if present).
`FAIL_HANDSHAKE` Don't trust the client during the SSL handshake.
`KEEP_OPEN` Keep the socket open after the response.
`NO_RESPONSE` Don't respond to the request but keep the socket open.
`RESET_STREAM_AT_START` Fail HTTP/2 requests without processing them by sending an HTTP/2 error code.
`SHUTDOWN_INPUT_AT_END` Shutdown the socket input after sending the response.
`SHUTDOWN_OUTPUT_AT_END` Shutdown the socket output after sending the response.
`UPGRADE_TO_SSL_AT_END` Wrap the socket with SSL at the completion of this request/response pair.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static SocketPolicy`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static SocketPolicy[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - KEEP_OPEN
```
public static final SocketPolicy KEEP_OPEN
```
    Keep the socket open after the response. This is the default HTTP/1.1 behavior.
  - DISCONNECT_AT_END
```
public static final SocketPolicy DISCONNECT_AT_END
```
    Close the socket after the response. This is the default HTTP/1.0 behavior. For HTTP/2 connections, this sends a GOAWAY frame immediately after the response and will close the connection when the client's socket is exhausted.
    See SocketPolicy for reasons why this can cause test flakiness and how to avoid it.
  - UPGRADE_TO_SSL_AT_END
```
public static final SocketPolicy UPGRADE_TO_SSL_AT_END
```
    Wrap the socket with SSL at the completion of this request/response pair. Used for CONNECT messages to tunnel SSL over an HTTP proxy.
  - DISCONNECT_AT_START
```
public static final SocketPolicy DISCONNECT_AT_START
```
    Request immediate close of connection without even reading the request. Use to simulate buggy SSL servers closing connections in response to unrecognized TLS extensions.
  - DISCONNECT_AFTER_REQUEST
```
public static final SocketPolicy DISCONNECT_AFTER_REQUEST
```
    Close connection after reading the request but before writing the response. Use this to simulate late connection pool failures.
  - DISCONNECT_DURING_REQUEST_BODY
```
public static final SocketPolicy DISCONNECT_DURING_REQUEST_BODY
```
    Close connection after reading half of the request body (if present).
  - DISCONNECT_DURING_RESPONSE_BODY
```
public static final SocketPolicy DISCONNECT_DURING_RESPONSE_BODY
```
    Close connection after writing half of the response body (if present).
  - FAIL_HANDSHAKE
```
public static final SocketPolicy FAIL_HANDSHAKE
```
    Don't trust the client during the SSL handshake.
  - SHUTDOWN_INPUT_AT_END
```
public static final SocketPolicy SHUTDOWN_INPUT_AT_END
```
    Shutdown the socket input after sending the response. For testing bad behavior.
    See SocketPolicy for reasons why this can cause test flakiness and how to avoid it.
  - SHUTDOWN_OUTPUT_AT_END
```
public static final SocketPolicy SHUTDOWN_OUTPUT_AT_END
```
    Shutdown the socket output after sending the response. For testing bad behavior.
    See SocketPolicy for reasons why this can cause test flakiness and how to avoid it.
  - NO_RESPONSE
```
public static final SocketPolicy NO_RESPONSE
```
    Don't respond to the request but keep the socket open. For testing read response header timeout issue.
  - RESET_STREAM_AT_START
```
public static final SocketPolicy RESET_STREAM_AT_START
```
    Fail HTTP/2 requests without processing them by sending an HTTP/2 error code.
- Method Detail
  - values
```
public static SocketPolicy[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (SocketPolicy c : SocketPolicy.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static SocketPolicy valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null

Enum SocketPolicy

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

KEEP_OPEN

DISCONNECT_AT_END

UPGRADE_TO_SSL_AT_END

DISCONNECT_AT_START

DISCONNECT_AFTER_REQUEST

DISCONNECT_DURING_REQUEST_BODY

DISCONNECT_DURING_RESPONSE_BODY

FAIL_HANDSHAKE

SHUTDOWN_INPUT_AT_END

SHUTDOWN_OUTPUT_AT_END

NO_RESPONSE

RESET_STREAM_AT_START

Method Detail

values

valueOf