Skip to main content

context

函数名函数描述/介绍
context.BackgroundBackground 返回空的 Context 接口(即上下文接口)
context.NewNew 返回空的 Context 接口(即上下文接口) 它实际是 context.Background 的别名
context.SecondsSeconds 返回一个超时时间为 d 秒的 Context 接口(即上下文接口) 它实际是 context.WithTimeoutSeconds 的别名
context.WithCancelWithCancel 返回继承自 parent 的 Context 接口(即上下文接口)和取消函数 当调用返回的取消函数或者 parent 的取消函数时,整个上下文会被取消
context.WithDeadlineWithDeadline 返回继承自 parent 的 Context 接口(即上下文接口)和取消函数 当调用返回的取消函数或者超出指定时间,整个上下文会被取消
context.WithTimeoutWithTimeout 返回继承自 parent 的 Context 接口(即上下文接口)和取消函数 当调用返回的取消函数或者超时,整个上下文会被取消
context.WithTimeoutSecondsWithTimeoutSeconds 返回超时时间为 d 秒的 Context 接口(即上下文接口)
context.WithValueWithValue 返回继承自 parent ,同时额外携带键值的 Context 接口(即上下文接口)和取消函数 当调用返回的取消函数时,整个上下文会被取消

函数定义#

Background#

详细描述#

Background 返回空的 Context 接口(即上下文接口)

Example:

ctx = context.Background()

定义#

Background() context.Context

返回值#

返回值(顺序)返回值类型返回值解释
r1context.Context

New#

详细描述#

New 返回空的 Context 接口(即上下文接口)

它实际是 context.Background 的别名

Example:

ctx = context.New()

定义#

New() context.Context

返回值#

返回值(顺序)返回值类型返回值解释
r1context.Context

Seconds#

详细描述#

Seconds 返回一个超时时间为 d 秒的 Context 接口(即上下文接口)

它实际是 context.WithTimeoutSeconds 的别名

Example:

ctx = context.Seconds(10)

定义#

Seconds(d float64) context.Context

参数#

参数名参数类型参数解释
dfloat64

返回值#

返回值(顺序)返回值类型返回值解释
r1context.Context

WithCancel#

详细描述#

WithCancel 返回继承自 parent 的 Context 接口(即上下文接口)和取消函数

当调用返回的取消函数或者 parent 的取消函数时,整个上下文会被取消

Example:

ctx, cancel = context.WithCancel(context.Background())defer cancel()

定义#

WithCancel(parent context.Context) (context.Context, context.CancelFunc)

参数#

参数名参数类型参数解释
parentcontext.Context

返回值#

返回值(顺序)返回值类型返回值解释
r1context.Context
r2context.CancelFunc

WithDeadline#

详细描述#

WithDeadline 返回继承自 parent 的 Context 接口(即上下文接口)和取消函数

当调用返回的取消函数或者超出指定时间,整个上下文会被取消

Example:

dur, err = time.ParseDuration("10s")after = time.Now().Add(dur)ctx, cancel := context.WithDeadline(context.Background(), after)defer cancel()

定义#

WithDeadline(parent context.Context, t time.Time) (context.Context, context.CancelFunc)

参数#

参数名参数类型参数解释
parentcontext.Context
ttime.Time

返回值#

返回值(顺序)返回值类型返回值解释
r1context.Context
r2context.CancelFunc

WithTimeout#

详细描述#

WithTimeout 返回继承自 parent 的 Context 接口(即上下文接口)和取消函数

当调用返回的取消函数或者超时,整个上下文会被取消

Example:

dur, err = time.ParseDuration("10s")ctx, cancel := context.WithTimeout(context.Background(), dur)defer cancel()

定义#

WithTimeout(parent context.Context, timeout time.Duration) (context.Context, context.CancelFunc)

参数#

参数名参数类型参数解释
parentcontext.Context
timeouttime.Duration

返回值#

返回值(顺序)返回值类型返回值解释
r1context.Context
r2context.CancelFunc

WithTimeoutSeconds#

详细描述#

WithTimeoutSeconds 返回超时时间为 d 秒的 Context 接口(即上下文接口)

Example:

ctx = context.WithTimeoutSeconds(10)

定义#

WithTimeoutSeconds(d float64) context.Context

参数#

参数名参数类型参数解释
dfloat64

返回值#

返回值(顺序)返回值类型返回值解释
r1context.Context

WithValue#

详细描述#

WithValue 返回继承自 parent ,同时额外携带键值的 Context 接口(即上下文接口)和取消函数

当调用返回的取消函数时,整个上下文会被取消

Example:

ctx = context.WithValue(context.Background(), "key", "value")ctx.Value("key") // "value"

定义#

WithValue(parent context.Context, key any, val any) context.Context

参数#

参数名参数类型参数解释
parentcontext.Context
keyany
valany

返回值#

返回值(顺序)返回值类型返回值解释
r1context.Context