mrhttp

Documentation

Index

• type Adapter
  • func NewAdapter(handler http.Handler, opts ...Option) *Adapter
  • func (a *Adapter) Caption() string
  • func (a *Adapter) ReadyTimeout() time.Duration
  • func (a *Adapter) Shutdown(ctx context.Context) error
  • func (a *Adapter) Start(ctx context.Context, ready func()) error
• type Option
  • func WithBaseContext(ctx context.Context) Option
  • func WithCaption(value string) Option
  • func WithHostAndPort(host, port string) Option
  • func WithLogger(value mrlog.Logger) Option
  • func WithReadTimeout(value time.Duration) Option
  • func WithShutdownTimeout(value time.Duration) Option
  • func WithWriteTimeout(value time.Duration) Option

Types

type Adapter

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

Adapter - Адаптер http сервера.

func NewAdapter

func NewAdapter(handler http.Handler, opts ...Option) *Adapter

NewAdapter - создаёт объект Adapter.

func (*Adapter) Caption

func (a *Adapter) Caption() string

Caption - возвращает название http сервера.

func (*Adapter) ReadyTimeout

func (a *Adapter) ReadyTimeout() time.Duration

ReadyTimeout - возвращает максимальное время, за которое должен быть запущен сервис.

func (*Adapter) Shutdown

func (a *Adapter) Shutdown(ctx context.Context) error

Shutdown - корректная остановка http сервера.

func (*Adapter) Start

func (a *Adapter) Start(ctx context.Context, ready func()) error

Start - запуск http сервера.

type Option

type Option func(s *Adapter)

Option - опция используемая при создании http сервера.

func WithBaseContext

func WithBaseContext(ctx context.Context) Option

WithBaseContext - устанавливает контекст, который будет использоваться в каждом запросе.

func WithCaption

func WithCaption(value string) Option

WithCaption - устанавливает название сервера.

func WithHostAndPort

func WithHostAndPort(host, port string) Option

WithHostAndPort - устанавливает хост (IP) и порт на которых будет работать http сервер.

func WithLogger

func WithLogger(value mrlog.Logger) Option

WithLogger - устанавливает логгер для логирования работы сервера.

func WithReadTimeout

func WithReadTimeout(value time.Duration) Option

WithReadTimeout - устанавливает таймаут при чтении заголовка и тела запроса.

func WithShutdownTimeout

func WithShutdownTimeout(value time.Duration) Option

WithShutdownTimeout - устанавливает таймаут для корректного завершения активных соединений при остановке сервера.

func WithWriteTimeout

func WithWriteTimeout(value time.Duration) Option

WithWriteTimeout - устанавливает таймаут на формирование ответа сервера.