deadline

Documentation

Overview

Package deadline provides deadline timer used to implement net.Conn compatible connection

Index

• type Deadline
  • func New() *Deadline
  • func (d *Deadline) Deadline() (time.Time, bool)
  • func (d *Deadline) Done() <-chan struct{}
  • func (d *Deadline) Err() error
  • func (d *Deadline) Set(t time.Time)
  • func (d *Deadline) Value(interface{}) interface{}

Types

type Deadline

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

Deadline signals updatable deadline timer. Also, it implements context.Context.

func New

func New() *Deadline

New creates new deadline timer.

func (*Deadline) Deadline

func (d *Deadline) Deadline() (time.Time, bool)

Deadline returns current deadline.

func (*Deadline) Done

func (d *Deadline) Done() <-chan struct{}

Done receives deadline signal.

func (*Deadline) Err

func (d *Deadline) Err() error

Err returns context.DeadlineExceeded if the deadline is exceeded. Otherwise, it returns nil.

func (*Deadline) Set

func (d *Deadline) Set(t time.Time)

Set new deadline. Zero value means no deadline.

func (*Deadline) Value

func (d *Deadline) Value(interface{}) interface{}

Value returns nil.