gencodec2

README

net-rpc-gencode

This library provides the same functions as net/rpc/jsonrpc but for communicating with gencode instead. The library is modeled directly after the Go standard library so it should be easy to use and obvious.

See the GoDoc for API documentation.

according to my test: Golang Serializer Benchmark Comparison, gencode is very faster than other serializers.

Example

gencode Schema

arith_test.schema:

struct Args {
	A int32
	B int32
}

struct Reply {
	C int32
}

run gencode go -schema arith_test.schema -package gencodec to generate data

RPC Server

package gencodec

import (
	"log"
	"net"
	"net/rpc"
	"github.com/smallnest/net-rpc-gencode"
)

type Arith int

func (t *Arith) Mul(args *Args, reply *Reply) error {
	reply.C = args.A * args.B
	return nil
}

func main() {
	rpc.Register(new(Arith))
	ln, e := net.Listen("tcp", "127.0.0.1:5432") // any available address
	if e != nil {
		log.Fatalf("net.Listen tcp :0: %v", e)
	}
	defer ln.Close()

	for {
		c, err := ln.Accept()
		if err != nil {
			continue
		}
		go gencodec.ServeConn(c)

	}
}

Client

package gencodec

import (
	"log"
	"net"
	"time"
	"github.com/smallnest/net-rpc-gencode"
)

func main() {
	client, err := gencodec.DialTimeout("tcp", "127.0.0.1:5432", time.Minute)
	if err != nil {
		fmt.Println("dialing:", err)
	}

	defer client.Close()

	// Synchronous call
	args := &gencodec.Args{7, 8}
	var reply Reply
	err = client.Call("Arith.Mul", args, &reply)
	if err != nil {
		fmt.Println("arith error:", err)
	} else {
		fmt.Printf("Arith: %d*%d=%d\n", args.A, args.B, reply.C)
	}
}

Documentation

Overview

Example

package main

import (
	"fmt"
	"log"
	"net"
	"time"

	"github.com/smallnest/net-rpc-gencode"
	"github.com/smallnest/rpcx/core"
)

type MyArith int

func (t *MyArith) Mul(args *gencodec.Args, reply *gencodec.Reply) error {
	reply.C = args.A * args.B
	return nil
}

func main() {
	core.Register(new(MyArith))
	ln, e := net.Listen("tcp", "127.0.0.1:0") // any available address
	if e != nil {
		log.Fatalf("net.Listen tcp :0: %v", e)
	}
	address := ln.Addr().String()
	defer ln.Close()

	go func() {
		for {
			c, err := ln.Accept()
			if err != nil {
				continue
			}
			go gencodec.ServeConn(c)

		}
	}()

	client, err := gencodec.DialTimeout("tcp", address, time.Minute)
	if err != nil {
		fmt.Println("dialing:", err)
	}

	defer client.Close()

	// Synchronous call
	args := &gencodec.Args{7, 8}
	var reply gencodec.Reply
	err = client.Call("MyArith.Mul", args, &reply)
	if err != nil {
		fmt.Println("arith error:", err)
	} else {
		fmt.Printf("Arith: %d*%d=%d\n", args.A, args.B, reply.C)
	}
}

Index

• func Dial(network, address string) (*core.Client, error)
• func DialTimeout(network, address string, timeout time.Duration) (*core.Client, error)
• func NewClient(conn io.ReadWriteCloser) *core.Client
• func NewGencodeClientCodec(rwc io.ReadWriteCloser) core.ClientCodec
• func NewGencodeServerCodec(rwc io.ReadWriteCloser) core.ServerCodec
• func ServeConn(conn io.ReadWriteCloser)
• type DecodeReader
• type RequestHeader
  • func (d *RequestHeader) Marshal(buf []byte) ([]byte, error)
  • func (d *RequestHeader) Size() (s uint64)
  • func (d *RequestHeader) Unmarshal(buf []byte) (uint64, error)
• type ResponseHeader
  • func (d *ResponseHeader) Marshal(buf []byte) ([]byte, error)
  • func (d *ResponseHeader) Size() (s uint64)
  • func (d *ResponseHeader) Unmarshal(buf []byte) (uint64, error)

Examples

• Package

Functions

func Dial

func Dial(network, address string) (*core.Client, error)

Dial connects to a Gencode-RPC server at the specified network address.

func DialTimeout

func DialTimeout(network, address string, timeout time.Duration) (*core.Client, error)

DialTimeout connects to a Gencode-RPC server at the specified network address with timeout.

func NewClient

func NewClient(conn io.ReadWriteCloser) *core.Client

NewClient returns a new core.Client to handle requests to the set of services at the other end of the connection.

func NewGencodeClientCodec

func NewGencodeClientCodec(rwc io.ReadWriteCloser) core.ClientCodec

NewGencodeClientCodec returns a new core.Client.

A ClientCodec implements writing of RPC requests and reading of RPC responses for the client side of an RPC session. The client calls WriteRequest to write a request to the connection and calls ReadResponseHeader and ReadResponseBody in pairs to read responses. The client calls Close when finished with the connection.

func NewGencodeServerCodec

func NewGencodeServerCodec(rwc io.ReadWriteCloser) core.ServerCodec

NewGencodeServerCodec returns a new core.ServerCodec.

A ServerCodec implements reading of RPC requests and writing of RPC responses for the server side of an RPC session. The server calls ReadRequestHeader and ReadRequestBody in pairs to read requests from the connection, and it calls WriteResponse to write a response back. The server calls Close when finished with the connection.

func ServeConn

func ServeConn(conn io.ReadWriteCloser)

ServeConn runs the Gencode-RPC server on a single connection. ServeConn blocks, serving the connection until the client hangs up. The caller typically invokes ServeConn in a go statement.

Types

type DecodeReader

type DecodeReader interface {
	io.ByteReader
	io.Reader
}

DecodeReader manages the receipt of type and data information read from the remote side of a connection.

type RequestHeader

type RequestHeader struct {
	ServiceMethod string
	Header        string
	Seq           uint64
}

func (*RequestHeader) Marshal

func (d *RequestHeader) Marshal(buf []byte) ([]byte, error)

func (*RequestHeader) Size

func (d *RequestHeader) Size() (s uint64)

func (*RequestHeader) Unmarshal

func (d *RequestHeader) Unmarshal(buf []byte) (uint64, error)

type ResponseHeader

type ResponseHeader struct {
	ServiceMethod string
	Header        string
	Seq           uint64
	Error         string
}

func (*ResponseHeader) Marshal

func (d *ResponseHeader) Marshal(buf []byte) ([]byte, error)

func (*ResponseHeader) Size

func (d *ResponseHeader) Size() (s uint64)

func (*ResponseHeader) Unmarshal

func (d *ResponseHeader) Unmarshal(buf []byte) (uint64, error)