tcpGateway

Documentation

Index

• Variables
• type Config
• type Gateway
  • func MustNew(config Config) *Gateway
  • func New(config Config) (*Gateway, error)
  • func (g *Gateway) Addr() []string
  • func (g *Gateway) GetConn(connID uint64) rony.Conn
  • func (g *Gateway) Run()
  • func (g *Gateway) Shutdown()
  • func (g *Gateway) Start()
  • func (g *Gateway) TotalConnections() int
• type UnsafeConn

Variables

var (
	ErrUnsupportedProtocol  = errors.New("gateway protocol is not supported")
	ErrWriteToClosedConn    = errors.New("write to closed conn")
	ErrUnexpectedSocketRead = errors.New("unexpected socket read")
	ErrOpCloseReceived      = errors.New("close operation received")
)

Types

type Config

type Config struct {
	Concurrency   int
	ListenAddress string
	MaxBodySize   int
	MaxIdleTime   time.Duration
	Protocol      gateway.Protocol
	ExternalAddrs []string
	CustomRouter  *router.Router
}

Config

type Gateway

type Gateway struct {
	gateway.ConnectHandler
	gateway.MessageHandler
	gateway.CloseHandler
	// contains filtered or unexported fields
}

Gateway

func MustNew

func MustNew(config Config) *Gateway

func New

func New(config Config) (*Gateway, error)

New

func (*Gateway) Addr

func (g *Gateway) Addr() []string

Addr return the address which gateway is listen on

func (*Gateway) GetConn

func (g *Gateway) GetConn(connID uint64) rony.Conn

GetConn returns the connection identified by connID

func (*Gateway) Run

func (g *Gateway) Run()

Run is blocking and runs the server endless loop until a non-temporary error happens

func (*Gateway) Shutdown

func (g *Gateway) Shutdown()

Shutdown

func (*Gateway) Start

func (g *Gateway) Start()

Start is non-blocking and call the Run function in background

func (*Gateway) TotalConnections

func (g *Gateway) TotalConnections() int

type UnsafeConn

type UnsafeConn interface {
	net.Conn
	UnsafeConn() net.Conn
}