client

README

Socket клиент.

Компонент предоставляет готовый и настроенный socket клиент. Реализует интерфейс Client, который доступен в контейнере объектов.

type Client interface {
	net.Conn
	Use(middlewares ...middleware.Func) Client
	SetConnector(connector net.Conn)
}

Socket клиент зависит от компонента протоколы TCP/UDP. Так же пакет предоставляет компонент мониторинга активности соединения.

Объект конфигурации.

type Config struct {
	WriteTimeout time.Duration
	ReadTimeout  time.Duration
}

Описание полей:

Поле	Описание	Значение по умолчанию
WriteTimeout	Таймаут для записи данных в сокет, этот параметр может быть передан одним из 3-х методов: - флаг командной строки --client.socket.timeout.write - переменная окружения CLIENT_SOCKET_TIMEOUT_WRITE - значение в конфиг файле client.socket.timeout.write	10s
ReadTimeout	Таймаут для чтения данных из сокет, этот параметр может быть передан одним из 3-х методов: - флаг командной строки --client.socket.timeout.read - переменная окружения CLIENT_SOCKET_TIMEOUT_READ - значение в конфиг файле client.socket.timeout.read	10s

Middleware.

Пакет предоставляет следующие готовые middleware, которые добавляются автоматически:

• Logger - логирует информацию о чтении/записи данных в/из сокета;
• ReadWriteCounter - добавляет метрику о кол. записанных/прочитанных данных.

Метрики.

Метрики добавляются автоматически при добавлении middleware:

go_socket_client_bytes - кол. записанных/прочитанных данных. Доступные лейблы в метрике:

• app - имя приложения;
• action - операция чтения/записи, read - чтение, write - запись;
• host - ip адрес хоста, с которым происходит обмен данными
• protocol - протокол tcp/udp, по которому происходит обмен.

Documentation

Index

• Variables
• type Client
  • func New(conn net.Conn) Client
• type Middleware
• type MiddlewareFunc
  • func (middleware MiddlewareFunc) Middleware(next net.Conn) net.Conn

Variables

var Component = &app.Component{
	Dependencies: app.Components{
		connector.Component,
		runner.Component,
	},
	Constructor: app.Constructor(func(container container.Container) error {
		return container.Provides(
			New,
		)
	}),
	Run: app.Run(func(container container.Container) error {
		return container.Invoke(func(socketClient Client, runner runner.Runner) error {
			return runner.AddProcesses(socketClient)
		})
	}),
}

Types

type Client

type Client interface {
	net.Conn
	runner.Process
	io.Closer
	Use(middlewares ...Middleware) Client
}

func New

func New(conn net.Conn) Client

type Middleware

type Middleware interface {
	Middleware(next net.Conn) net.Conn
}

type MiddlewareFunc

type MiddlewareFunc func(next net.Conn) net.Conn

func (MiddlewareFunc) Middleware

func (middleware MiddlewareFunc) Middleware(next net.Conn) net.Conn