tcp

Documentation

Index

• Constants
• func New(address string, opts ...Option) checker.Checker
• type Option
  • func WithTimeout(timeout time.Duration) Option
• type TCP
  • func (t *TCP) Check(ctx context.Context) error
  • func (t *TCP) Identity() (string, error)

Constants

const (
	// DefaultConnectionTimeout is the default connection timeout duration
	DefaultConnectionTimeout = 3 * time.Second
)

Functions

func New

func New(address string, opts ...Option) checker.Checker

New creates the TCP checker

Types

type Option

type Option func(t *TCP)

Option configures a TCP.

func WithTimeout

func WithTimeout(timeout time.Duration) Option

WithTimeout configures a timeout for maximum amount of time a dial will wait for a connection to complete

type TCP

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

TCP represents TCP checker

func (*TCP) Check

func (t *TCP) Check(ctx context.Context) error

Check checks TCP connection

func (*TCP) Identity

func (t *TCP) Identity() (string, error)

Identity returns the identity of the checker