rpc

README

rpc

此库弃用，不再维护，建议使用以下package

github.com/zituocn/gow/lib/gb

Documentation

Index

• func GetIp() (string, error)
• func GetLocalIP() (string, error)
• func ID() string
• func LocalIPv4s() ([]string, error)
• type Client
  • func NewClient(dis ClientArg) (*Client, error)
  • func (c *Client) Conn() (client *grpc.ClientConn, ctx context.Context, err error)
  • func (c *Client) Min() (client *grpc.ClientConn, ctx context.Context, err error)
  • func (c *Client) Rand() (client *grpc.ClientConn, ctx context.Context, err error)
• type ClientArg
• type EtcdCli
  • func NewEtcdCli(etcdAddr []string) *EtcdCli
  • func (etcdCil *EtcdCli) Conn() (*EtcdCli, error)
  • func (etcdCil *EtcdCli) Delete(key string) error
  • func (etcdCil *EtcdCli) DeleteAll(key string) error
  • func (etcdCil *EtcdCli) Get(key string) (*clientv3.GetResponse, error)
  • func (etcdCil *EtcdCli) GetAllKey(key string) ([]string, error)
  • func (etcdCil *EtcdCli) GetHash(key, h string)
  • func (etcdCil *EtcdCli) GetMinKey(key string) (string, error)
  • func (etcdCil *EtcdCli) GetMinKeyCallBack(key string) error
  • func (etcdCil *EtcdCli) GetRandKey(key string) (string, error)
  • func (etcdCil *EtcdCli) Register(key, value string) error
  • func (etcdCil *EtcdCli) SetConnTimeOut(timeOut int) *EtcdCli
  • func (etcdCil *EtcdCli) SetTTl(ttl int) *EtcdCli
  • func (etcdCil *EtcdCli) UnRegister(key string) error
• type Server
  • func NewServer(grpcAddr ServerArg) (server *Server, err error)
  • func (m *Server) OpenRegister() *Server
  • func (m *Server) Run()
  • func (m *Server) SetEtcdAddr(etcdAddr string) *Server
  • func (m *Server) SetName(name string) *Server
  • func (m *Server) SetPort(port int) *Server
• type ServerArg
  • func (addr ServerArg) String() string

Functions

func GetIp

func GetIp() (string, error)

GetIp return ip address

func GetLocalIP

func GetLocalIP() (string, error)

GetLocalIP get local ip address

returns address and error

func ID

func ID() string

ID return id

func LocalIPv4s

func LocalIPv4s() ([]string, error)

LocalIPv4s return all non-loop back IPv4 addresses

Types

type Client

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

Client GRPC Client struct

func NewClient

func NewClient(dis ClientArg) (*Client, error)

NewClient return grpc Client obj

func (*Client) Conn

func (c *Client) Conn() (client *grpc.ClientConn, ctx context.Context, err error)

Conn 直连 return grpc.ClientConn, context.Context, err

func (*Client) Min

func (c *Client) Min() (client *grpc.ClientConn, ctx context.Context, err error)

Min 通过etcd发现服务获取grpc连接; 负载均衡 - 最小连接数法; return grpc.ClientConn, context.Context, err

func (*Client) Rand

func (c *Client) Rand() (client *grpc.ClientConn, ctx context.Context, err error)

Rand 通过etcd发现服务获取grpc连接; 负载均衡 - 随机法; return grpc.ClientConn, context.Context, err

type ClientArg

type ClientArg struct {
	ServerAddr  string // 直连  *必填
	EtcdAddr    string // 使用发现服务 *必填
	ClientName  string
	ServiceName string // *必填
}

ClientArg GRPC Client arg struct

type EtcdCli

type EtcdCli struct {
	EtcdAddr []string
	// contains filtered or unexported fields
}

EtcdCli etcd cli struct

func NewEtcdCli

func NewEtcdCli(etcdAddr []string) *EtcdCli

NewEtcdCli new etcd cli

func (*EtcdCli) Conn

func (etcdCil *EtcdCli) Conn() (*EtcdCli, error)

Conn return *EtcdCli error

func (*EtcdCli) Delete

func (etcdCil *EtcdCli) Delete(key string) error

Delete delete key

return error

func (*EtcdCli) DeleteAll

func (etcdCil *EtcdCli) DeleteAll(key string) error

DeleteAll delete all key by Prefix

returns error

func (*EtcdCli) Get

func (etcdCil *EtcdCli) Get(key string) (*clientv3.GetResponse, error)

Get return *clientv3.GetResponse error

func (*EtcdCli) GetAllKey

func (etcdCil *EtcdCli) GetAllKey(key string) ([]string, error)

GetAllKey 使用前缀key查询值

func (*EtcdCli) GetHash

func (etcdCil *EtcdCli) GetHash(key, h string)

GetHash 通过传入h把value进行hash,然后后返回 h : 用于计算hash的值

func (*EtcdCli) GetMinKey

func (etcdCil *EtcdCli) GetMinKey(key string) (string, error)

GetMinKey 获取被计数最少的key

func (*EtcdCli) GetMinKeyCallBack

func (etcdCil *EtcdCli) GetMinKeyCallBack(key string) error

GetMinKeyCallBack 是GetMinKey方法的回调

func (*EtcdCli) GetRandKey

func (etcdCil *EtcdCli) GetRandKey(key string) (string, error)

GetRandKey 使用前缀key查询随机反回一个

func (*EtcdCli) Register

func (etcdCil *EtcdCli) Register(key, value string) error

Register 注册,并创建租约

func (*EtcdCli) SetConnTimeOut

func (etcdCil *EtcdCli) SetConnTimeOut(timeOut int) *EtcdCli

SetConnTimeOut set etcd conn timeout

func (*EtcdCli) SetTTl

func (etcdCil *EtcdCli) SetTTl(ttl int) *EtcdCli

SetTTl set ttl

func (*EtcdCli) UnRegister

func (etcdCil *EtcdCli) UnRegister(key string) error

UnRegister 解除注册

type Server

type Server struct {
	Listener net.Listener
	Server   *grpc.Server
	Port     int
	Name     string
	EtcdAddr []string
	// contains filtered or unexported fields
}

Server GRPC Server struct

func NewServer

func NewServer(grpcAddr ServerArg) (server *Server, err error)

NewServer returns a new server

func (*Server) OpenRegister

func (m *Server) OpenRegister() *Server

OpenRegister set isRegister=true

func (*Server) Run

func (m *Server) Run()

Run run rpc server

func (*Server) SetEtcdAddr

func (m *Server) SetEtcdAddr(etcdAddr string) *Server

SetEtcdAddr set etcd address

func (*Server) SetName

func (m *Server) SetName(name string) *Server

SetName set grpc server name

func (*Server) SetPort

func (m *Server) SetPort(port int) *Server

SetPort set grpc port

type ServerArg

type ServerArg struct {
	IP       string
	Port     int    // *必填
	Name     string // *必填
	EtcdAddr string // 多个地址必须使用","分开; 如: 192.168.0.1:2379,192.168.0.2:2379
	Register bool   // 是否启用服务注册
}

ServerArg GRPC Server Arg struct

func (ServerArg) String

func (addr ServerArg) String() string

String ServerArg ip -> string