Install

GO111MODULE=on go get -u -v -insecure github.com/andeya/erpc/v7

import"github.com/andeya/erpc/v7"

Feature

Benchmark

Example

server.go

package mainimport ("fmt""time""github.com/andeya/erpc/v7")funcmain() {defererpc.FlushLogger()// gracefulgoerpc.GraceSignal()// server peersrv:=erpc.NewPeer(erpc.PeerConfig{CountTime:true,ListenPort:9090,PrintDetail:true,})// srv.SetTLSConfig(erpc.GenerateTLSConfigForServer())// routersrv.RouteCall(new(Math))// broadcast per 5sgofunc() {for {time.Sleep(time.Second*5)srv.RangeSession(func(sess erpc.Session)bool {sess.Push("/push/status",fmt.Sprintf("this is a broadcast, server time: %v",time.Now()),)returntrue})}}()// listen and servesrv.ListenAndServe()}// Math handlertypeMathstruct {erpc.CallCtx}// Add handles addition requestfunc (m*Math)Add(arg*[]int) (int,*erpc.Status) {// test metaerpc.Infof("author: %s",m.PeekMeta("author"))// addvarrintfor_,a:=range*arg {r+=a}// responsereturnr,nil}

client.go

package mainimport ("time""github.com/andeya/erpc/v7")funcmain() {defererpc.SetLoggerLevel("ERROR")()cli:=erpc.NewPeer(erpc.PeerConfig{})defercli.Close()// cli.SetTLSConfig(&tls.Config{InsecureSkipVerify: true})cli.RoutePush(new(Push))sess,stat:=cli.Dial(":9090")if!stat.OK() {erpc.Fatalf("%v",stat)  }varresultintstat=sess.Call("/math/add",    []int{1,2,3,4,5},&result,erpc.WithAddMeta("author","andeya"),  ).Status()if!stat.OK() {erpc.Fatalf("%v",stat)  }erpc.Printf("result: %d",result)erpc.Printf("Wait 10 seconds to receive the push...")time.Sleep(time.Second*10)}// Push push handlertypePushstruct {  erpc.PushCtx}// Push handles '/push/status' messagefunc (p*Push)Status(arg*string)*erpc.Status {erpc.Printf("%s",*arg)returnnil}

Usage

Peer(server or client) Demo

// Start a servervarpeer1=erpc.NewPeer(erpc.PeerConfig{ListenPort:9090,// for server role})peer1.Listen()...// Start a clientvarpeer2=erpc.NewPeer(erpc.PeerConfig{})varsess,err=peer2.Dial("127.0.0.1:8080")

Call-Struct API template

typeAaastruct {    erpc.CallCtx}func (x*Aaa)XxZz(arg*<T>) (<T>,*erpc.Status) {...returnr,nil}

// register the call route// HTTP mapping: /aaa/xx_zz// RPC mapping: Aaa.XxZzpeer.RouteCall(new(Aaa))// or register the call route// HTTP mapping: /xx_zz// RPC mapping: XxZzpeer.RouteCallFunc((*Aaa).XxZz)

Service method mapping

Call-Function API template

funcXxZz(ctx erpc.CallCtx,arg*<T>) (<T>,*erpc.Status) {...returnr,nil}

// register the call route// HTTP mapping: /xx_zz// RPC mapping: XxZzpeer.RouteCallFunc(XxZz)

Push-Struct API template

typeBbbstruct {    erpc.PushCtx}func (b*Bbb)YyZz(arg*<T>)*erpc.Status {...returnnil}

// register the push handler// HTTP mapping: /bbb/yy_zz// RPC mapping: Bbb.YyZzpeer.RoutePush(new(Bbb))// or register the push handler// HTTP mapping: /yy_zz// RPC mapping: YyZzpeer.RoutePushFunc((*Bbb).YyZz)

Push-Function API template

// YyZz register the handlerfuncYyZz(ctx erpc.PushCtx,arg*<T>)*erpc.Status {...returnnil}

// register the push handler// HTTP mapping: /yy_zz// RPC mapping: YyZzpeer.RoutePushFunc(YyZz)

Unknown-Call-Function API template

funcXxxUnknownCall (ctx erpc.UnknownCallCtx) (interface{},*erpc.Status) {...returnr,nil}

// register the unknown call route: /*peer.SetUnknownCall(XxxUnknownCall)

Unknown-Push-Function API template

funcXxxUnknownPush(ctx erpc.UnknownPushCtx)*erpc.Status {...returnnil}

// register the unknown push route: /*peer.SetUnknownPush(XxxUnknownPush)

Plugin Demo

// NewIgnoreCase Returns a ignoreCase plugin.funcNewIgnoreCase()*ignoreCase {return&ignoreCase{}}typeignoreCasestruct{}var (_ erpc.PostReadCallHeaderPlugin=new(ignoreCase)_ erpc.PostReadPushHeaderPlugin=new(ignoreCase))func (i*ignoreCase)Name()string {return"ignoreCase"}func (i*ignoreCase)PostReadCallHeader(ctx erpc.ReadCtx)*erpc.Status {// Dynamic transformation path is lowercasectx.UriObject().Path=strings.ToLower(ctx.UriObject().Path)returnnil}func (i*ignoreCase)PostReadPushHeader(ctx erpc.ReadCtx)*erpc.Status {// Dynamic transformation path is lowercasectx.UriObject().Path=strings.ToLower(ctx.UriObject().Path)returnnil}

Register above handler and plugin

// add router groupgroup:=peer.SubRoute("test")// register to test groupgroup.RouteCall(new(Aaa),NewIgnoreCase())peer.RouteCallFunc(XxZz,NewIgnoreCase())group.RoutePush(new(Bbb))peer.RoutePushFunc(YyZz)peer.SetUnknownCall(XxxUnknownCall)peer.SetUnknownPush(XxxUnknownPush)

Config

typePeerConfigstruct {Networkstring`yaml:"network"              ini:"network"              comment:"Network; tcp, tcp4, tcp6, unix, unixpacket, kcp or quic"`LocalIPstring`yaml:"local_ip"             ini:"local_ip"             comment:"Local IP"`ListenPortuint16`yaml:"listen_port"          ini:"listen_port"          comment:"Listen port; for server role"`DialTimeout time.Duration`yaml:"dial_timeout" ini:"dial_timeout" comment:"Default maximum duration for dialing; for client role; ns,µs,ms,s,m,h"`RedialTimesint32`yaml:"redial_times"         ini:"redial_times"         comment:"The maximum times of attempts to redial, after the connection has been unexpectedly broken; Unlimited when <0; for client role"`RedialInterval     time.Duration`yaml:"redial_interval"      ini:"redial_interval"      comment:"Interval of redialing each time, default 100ms; for client role; ns,µs,ms,s,m,h"`DefaultBodyCodecstring`yaml:"default_body_codec"   ini:"default_body_codec"   comment:"Default body codec type id"`DefaultSessionAge  time.Duration`yaml:"default_session_age"  ini:"default_session_age"  comment:"Default session max age, if less than or equal to 0, no time limit; ns,µs,ms,s,m,h"`DefaultContextAge  time.Duration`yaml:"default_context_age"  ini:"default_context_age"  comment:"Default CALL or PUSH context max age, if less than or equal to 0, no time limit; ns,µs,ms,s,m,h"`SlowCometDuration  time.Duration`yaml:"slow_comet_duration"  ini:"slow_comet_duration"  comment:"Slow operation alarm threshold; ns,µs,ms,s ..."`PrintDetailbool`yaml:"print_detail"         ini:"print_detail"         comment:"Is print body and metadata or not"`CountTimebool`yaml:"count_time"           ini:"count_time"           comment:"Is count cost time or not"`}

Optimize

Extensions

Codec

Plugin

Protocol

Transfer-Filter

Mixer

Projects based on eRPC

Business Users

License