server

Documentation

Index

• Variables
• type Interface
• type Runnable
• type TickHandler
• type TickManager

Variables

var (
	Version = "0.1.0-dev"
	Branch  = "unknown"
	Commit  = "unknown"
)

Build information, meant to be populated by Go's linker.

Types

type Interface

type Interface interface {
	Runnable
	// GetKind returns what kind of a server interface this is in human readable form.
	GetKind() string
}

type Runnable

type Runnable interface {
	// Starts tasks the underlying runnable to start processing.
	Start()
	// Stops the underlying runnable from further processing. If deadline is nil, the intent is a
	// forceful close. Otherwise attempts a graceful close.
	Stop(deadline *time.Time)
}

type TickHandler

type TickHandler func(tick time.Time)

type TickManager

type TickManager interface {
	OnTickSecond(handler TickHandler)
	OnTickMinute(handler TickHandler)
	OnTickHour(handler TickHandler)
}