multiclient

README

multiclient

Higher throughput client connection pool when transferring large messages (such as downloading files).

Feature

• Non exclusive, shared connection pool
• Making full use of the asynchronous communication advantages of each connection
• Higher throughput when transferring large messages(≥1MB)
• Preempt more network bandwidth in a shared network environment
• Load balancing mechanism of traffic level
• Real-time monitoring of connection status

Usage

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

Test

package multiclient_test

import (
	"testing"
	"time"

	"github.com/andeya/erpc/v7"
	"github.com/andeya/erpc/v7/mixer/multiclient"
)

type Arg struct {
	A int
	B int `param:"<range:1:>"`
}

type P struct{ erpc.CallCtx }

func (p *P) Divide(arg *Arg) (int, *erpc.Status) {
	return arg.A / arg.B, nil
}

func TestMultiClient(t *testing.T) {
	srv := erpc.NewPeer(erpc.PeerConfig{
		ListenPort: 9090,
	})
	srv.RouteCall(new(P))
	go srv.ListenAndServe()
	time.Sleep(time.Second)

	cli := multiclient.New(
		erpc.NewPeer(erpc.PeerConfig{}),
		":9090",
		100,
		time.Second*5,
	)
	go func() {
		for {
			t.Logf("%+v", cli.Stats())
			time.Sleep(time.Millisecond * 500)
		}
	}()
	go func() {
		var result int
		for i := 0; ; i++ {
			stat := cli.Call("/p/divide", &Arg{
				A: i,
				B: 2,
			}, &result).Status()
			if !stat.OK() {
				t.Log(stat)
			} else {
				t.Logf("%d/2=%v", i, result)
			}
			time.Sleep(time.Millisecond * 500)
		}
	}()
	time.Sleep(time.Second * 6)
	cli.Close()
	time.Sleep(time.Second * 3)
}

test command:

go test -v -run=TestMultiClient

Documentation

Overview

Package multiclient is a higher throughput client connection pool when transferring large messages (such as downloading files).

Copyright 2018 HenryLee. All Rights Reserved.

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

• type MultiClient
  • func New(peer erpc.Peer, addr string, sessMaxQuota int, ...) *MultiClient
  • func (c *MultiClient) Addr() string
  • func (c *MultiClient) AsyncCall(uri string, arg interface{}, result interface{}, ...) erpc.CallCmd
  • func (c *MultiClient) Call(uri string, arg interface{}, result interface{}, ...) erpc.CallCmd
  • func (c *MultiClient) Close()
  • func (c *MultiClient) Peer() erpc.Peer
  • func (c *MultiClient) Push(uri string, arg interface{}, setting ...erpc.MessageSetting) *erpc.Status
  • func (c *MultiClient) Stats() pool.WorkshopStats

Types

type MultiClient

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

MultiClient client session which is has connection pool

func New

func New(peer erpc.Peer, addr string, sessMaxQuota int, sessMaxIdleDuration time.Duration, protoFunc ...erpc.ProtoFunc) *MultiClient

New creates a client session which is has connection pool.

func (*MultiClient) Addr

func (c *MultiClient) Addr() string

Addr returns the address.

func (*MultiClient) AsyncCall

func (c *MultiClient) AsyncCall(
	uri string,
	arg interface{},
	result interface{},
	callCmdChan chan<- erpc.CallCmd,
	setting ...erpc.MessageSetting,
) erpc.CallCmd

AsyncCall sends a message and receives reply asynchronously. If the arg is []byte or *[]byte type, it can automatically fill in the body codec name.

func (*MultiClient) Call

func (c *MultiClient) Call(uri string, arg interface{}, result interface{}, setting ...erpc.MessageSetting) erpc.CallCmd

Call sends a message and receives reply. NOTE: If the arg is []byte or *[]byte type, it can automatically fill in the body codec name; If the session is a client role and PeerConfig.RedialTimes>0, it is automatically re-called once after a failure.

func (*MultiClient) Close

func (c *MultiClient) Close()

Close closes the session.

func (*MultiClient) Peer

func (c *MultiClient) Peer() erpc.Peer

Peer returns the peer.

func (*MultiClient) Push

func (c *MultiClient) Push(uri string, arg interface{}, setting ...erpc.MessageSetting) *erpc.Status

Push sends a message, but do not receives reply. NOTE: If the arg is []byte or *[]byte type, it can automatically fill in the body codec name; If the session is a client role and PeerConfig.RedialTimes>0, it is automatically re-called once after a failure.

func (*MultiClient) Stats

func (c *MultiClient) Stats() pool.WorkshopStats

Stats returns the current session pool stats.