目录

Request.Builder

Class Info

public abstract static class Request.Builder

Request的构造器。使用HttpClient的newRequest方法构造Request.Builder实例。

Public Constructor Summary

Constructor Name

public Request.Builder()

默认的构造方法。

Public Method Summary

Qualifier and Type

Method Name and Description

public abstract Request.Builder

addHeader(String name, String value)

添加单个消息头。

public abstract Request

build()

构造Request实例。

public abstract Request.Builder

method(String method)

配置请求方式。

public abstract Request.Builder

options(String options)

配置Request.Builder构造的Request实例的配置信息。

public abstract Request.Builder

removeHeader(String name)

移除请求中“name”对应的消息头。

public abstract Request.Builder

requestBody(RequestBody requestBody)

设置请求数据体。

public abstract Request.Builder

url(String url)

设置请求URL地址。

Public Constructors

[h2]Request.Builder

Constructor

public Request.Builder()

默认的构造方法，构造Request.Builder对象。

Public Methods

[h2]addHeader

Method

public abstract Request.Builder addHeader(String name, String value)

添加单个消息头。

Parameters

Name

Description

name

消息头名称。

value

消息头值。

Returns

Type

Description

Request.Builder

Request构造器。

[h2]build

Method

public abstract Request build()

构造Request实例。

Returns

Type

Description

Request

构造的Request实例。

[h2]method

Method

public abstract Request.Builder method(String method)

配置请求方式。

Parameters

Name

Description

method

请求方式。

  • GET：“GET”请求方式
  • POST：“POST”请求方式
  • PUT：“PUT”请求方式
  • DELETE：“DELETE”请求方式
  • HEAD：“HEAD”请求方式

Returns

Type

Description

Request.Builder

Request构造器。

[h2]options

Method

public abstract Request.Builder options(String options)

配置Request.Builder构造的Request实例的配置信息。

Parameters

Name

Description

options

配置信息，使用JSON格式。例如：{"call_timeout":10000,"connect_empty_body":true}。支持参数请参见options。

options

Description

call_timeout

配置请求超时参数，int类型，单位：ms。默认值为0，请求超时不生效。取值范围为：20≤call_timeout。当您使用全双工模式时不应设置此参数。

concurrent_connect_delay
配置复合建链超时参数，int类型，单位：ms。默认值为：500。

connect_empty_body
配置是否建链和传输数据，boolean类型。默认值为：false。
  • true：仅建链，不传输数据
  • false：建链并传输数据

connect_timeout
配置连接超时参数，int类型，单位：ms。默认值为：10000。
  • 当concurrent_connect_delay小于等于1000时，取值范围为：1000≤connect_timeout。
  • 当concurrent_connect_delay取值大于1000时。取值范围为：concurrent_connect_delay<connect_timeout。

enable_concurrent_connect
配置是否开启复合建链，boolean类型。默认值为：true。
  • true：开启复合建链
  • false：不开启复合建链

ping_interval

配置ping帧探测时间间隔参数，int类型，单位：ms。默认值为：0，ping帧探测特性不生效。取值范围为：0<ping_interval。

read_timeout

配置读超时时间参数，int类型，单位：ms。默认值为：10000。取值范围为：0<read_timeout。

retry_time

配置请求重试次数参数，重试条件为I/O异常，int类型，单位：次。默认值为：1，一次失败重试。取值范围为：0≤retry_time。

write_timeout

配置写超时时间参数，int类型，单位：ms。默认值为：10000。取值范围为：0<write_timeout。

Returns

Type

Description

Request.Builder

Request构造器。

[h2]removeHeader

Method

public abstract Request.Builder removeHeader(String name)

移除请求中“name”对应的消息头。

Parameters

Name

Description

name

头信息名称。

Returns

Type

Description

Request.Builder

Request构造器。

[h2]requestBody

Method

public abstract Request.Builder requestBody(RequestBody requestBody)

设置请求数据体。

Parameters

Name

Description

requestBody

请求数据体。

Returns

Type

Description

Request.Builder

Request构造器。

[h2]url

Method

public abstract Request.Builder url(String url)

设置请求URL地址。

Parameters

Name

Description

url

请求URL地址。

Returns

Type

Description

Request.Builder

Request构造器。