transport

Documentation

Overview

Package transport is the network client layer. It is only used for basic binary body network communication without any business logic. By default, there is only one pluggable ServerTransport.

Index

• type Handler
• type Options
• type Transport

Types

type Handler

type Handler interface {
	Handle(ctx context.Context, req []byte) (rsp []byte, err error)
}

Handler is the process function when server client receive a package.

type Options

type Options struct {
	ServiceName string
	Protocol    string
	Address     string
	Network     string
	Handler     Handler
	Listener    net.Listener

	EventLoopNum    int           // epoll loop 大小，默认取 CPU 核数
	IdleTimeout     time.Duration // 连接最大空闲时间
	KeepAlivePeriod time.Duration
	EnableH2C       bool

	CACertFile  string // ca certification file
	TLSCertFile string // server certification file
	TLSKeyFile  string // server key file
}

Options is the server options on start.

type Transport

type Transport interface {
	Serve(ctx context.Context, opts *Options) error
}

Transport defines the server client layer interface.