idle

Documentation

Overview

Package idle contains a component for managing idleness (entering and exiting) based on RPC activity.

Index

• type Enforcer
• type Manager
  • func NewManager(opts ManagerOptions) Manager
• type ManagerOptions

Types

type Enforcer

type Enforcer interface {
	ExitIdleMode() error
	EnterIdleMode() error
}

Enforcer is the functionality provided by grpc.ClientConn to enter and exit from idle mode.

type Manager

type Manager interface {
	OnCallBegin() error
	OnCallEnd()
	Close()
}

Manager defines the functionality required to track RPC activity on a channel.

func NewManager

func NewManager(opts ManagerOptions) Manager

NewManager creates a new idleness manager implementation for the given idle timeout.

type ManagerOptions

type ManagerOptions struct {
	Enforcer Enforcer
	Timeout  time.Duration
	Logger   grpclog.LoggerV2
}

ManagerOptions is a collection of options used by NewManager.