xtcp

Documentation

Overview

Copyright 2022 NetEase Media Technology（Beijing）Co., Ltd.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Variables
• type Option
• type Server
  • func New(opt *Option) *Server
  • func (server *Server) Initial() (err error)
  • func (server *Server) Listen() error
  • func (server *Server) RegisterHandler(handler func(net.Conn, context.Context))

Variables

var (
	NoHandlerError = errors.New("no handler error")
)

Types

type Option

type Option struct {
	Name string // name
	IP   string // default 0.0.0.0
	Port int32  // default 8888
	Type string // "tcp" "tcp4" ....
}

type Server

type Server struct {
	Handler func(net.Conn, context.Context)
	// contains filtered or unexported fields
}

func New

func New(opt *Option) *Server

func (*Server) Initial

func (server *Server) Initial() (err error)

Initial start listening

func (*Server) Listen

func (server *Server) Listen() error

Listen prepare to handle events

func (*Server) RegisterHandler

func (server *Server) RegisterHandler(handler func(net.Conn, context.Context))