rpc

README

gitub.com/gkzy/gow/lib/rpc

server

// InitRPCServer 
func InitRPCServer(){
    g,err:=rpc.NewServer(10001)
    if err!=nil{
        panic(err)
    }
    handler(g.Server)
    g.Run()
}

// handler register struct
func handler(g *rpc.Server){

}

client

client,err:=rpc.NewClient("192.168.0.100",10001)
if err!=nil{
        panic(err)
}
...

Documentation

Index

• Constants
• Variables
• func NewClient(serverAddr string, serverPort int) (client *grpc.ClientConn, err error)
• type Client
  • func (client *Client) Close()
  • func (client *Client) Destroy()
  • func (client *Client) TimeInit() time.Time
  • func (client *Client) TimeUsed() time.Time
• type Factor
• type Option
• type Pool
  • func DefaultPool(factor Factor, init, cap int32) (*Pool, error)
  • func NewPool(option *Option) (*Pool, error)
  • func (pool *Pool) Close()
  • func (pool *Pool) ConnCnt() int32
  • func (pool *Pool) Get(ctx context.Context) (*Client, error)
  • func (pool *Pool) IsClose() bool
  • func (pool *Pool) Size() int
• type Server
  • func NewServer(port int) (server *Server, err error)
  • func (m *Server) Run()

Constants

const (
	// PoolModeStrict 在实际创建连接数达上限后，池子中没有连接时不会新建连接
	PoolModeStrict = iota

	// PoolModeLoose 在实际创建连接数达上限后，池子中没有连接时会新建连接
	PoolModeLoose
)

Variables

var (
	// ErrorOption
	ErrorOption = "option error"
	// ErrorPoolInit 连接p池初始化出错
	ErrorPoolInit = "pool init error"
	//ErrorGetTimeout 获取连接超时
	ErrorGetTimeout = "getting connection client timeout from pool"
	//ErrorDialConn 创建连接时发生错误
	ErrorDialConn = "dialing connection error"

	// ErrorPoolIsClosed 连接池已关闭
	ErrorPoolIsClosed = "pool is closed"
)

Functions

func NewClient

func NewClient(serverAddr string, serverPort int) (client *grpc.ClientConn, err error)

NewClient 返回rpc客户端

serverAddr:服务端地址
serverPort:服务端Port

Types

type Client

type Client struct {
	*grpc.ClientConn
	// contains filtered or unexported fields
}

Client grpc client

func (*Client) Close

func (client *Client) Close()

Close close conn

func (*Client) Destroy

func (client *Client) Destroy()

Destroy destroy conn

func (*Client) TimeInit

func (client *Client) TimeInit() time.Time

TimeInit 连的创建时间

func (*Client) TimeUsed

func (client *Client) TimeUsed() time.Time

TimeUsed 连接上一次的使用时间

type Factor

type Factor func() (*grpc.ClientConn, error)

Factor factor func

type Option

type Option struct {
	// func() (*grpc.ClientConn, error)
	Factor Factor

	//Init init 连接数
	Init int32

	//Cap 连接上限
	Cap int32

	//IdleDur
	IdleDur time.Duration

	// MaxLifeDur
	MaxLifeDur time.Duration

	// Timeout pool关闭时
	Timeout time.Duration

	// 模式
	Mode int
}

Option pool param option

type Pool

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

Pool 连接池

func DefaultPool

func DefaultPool(factor Factor, init, cap int32) (*Pool, error)

DefaultPool return a default pool

func NewPool

func NewPool(option *Option) (*Pool, error)

NewPool return a new pool

need option

func (*Pool) Close

func (pool *Pool) Close()

func (*Pool) ConnCnt

func (pool *Pool) ConnCnt() int32

ConnCnt 实际连接数

func (*Pool) Get

func (pool *Pool) Get(ctx context.Context) (*Client, error)

Get 从连接池取出一个链接

func (*Pool) IsClose

func (pool *Pool) IsClose() bool

func (*Pool) Size

func (pool *Pool) Size() int

Size return pool client size

type Server

type Server struct {
	Listener net.Listener
	Server   *grpc.Server
	Port     int //端口
}

Server GRPCServer

func NewServer

func NewServer(port int) (server *Server, err error)

NewServer init一个新的服务

func (*Server) Run

func (m *Server) Run()

Run run rpc server