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(enforcer Enforcer, timeout time.Duration) *Manager
  • func (m *Manager) Close()
  • func (m *Manager) EnterIdleModeForTesting()
  • func (m *Manager) ExitIdleMode() error
  • func (m *Manager) OnCallBegin() error
  • func (m *Manager) OnCallEnd()

Types

type Enforcer

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

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

type Manager

type Manager struct {
	// contains filtered or unexported fields
}

Manager implements idleness detection and calls the configured Enforcer to enter/exit idle mode when appropriate. Must be created by NewManager.

func NewManager

func NewManager(enforcer Enforcer, timeout time.Duration) *Manager

NewManager creates a new idleness manager implementation for the given idle timeout. It begins in idle mode.

func (*Manager) Close

func (m *Manager) Close()

Close stops the timer associated with the Manager, if it exists.

func (*Manager) EnterIdleModeForTesting

func (m *Manager) EnterIdleModeForTesting()

EnterIdleModeForTesting instructs the channel to enter idle mode.

func (*Manager) ExitIdleMode

func (m *Manager) ExitIdleMode() error

ExitIdleMode instructs m to call the enforcer's ExitIdleMode and update m's internal state.

func (*Manager) OnCallBegin

func (m *Manager) OnCallBegin() error

OnCallBegin is invoked at the start of every RPC.

func (*Manager) OnCallEnd

func (m *Manager) OnCallEnd()

OnCallEnd is invoked at the end of every RPC.