jsonproto

README

jsonproto

jsonproto is implemented JSON socket communication protocol.

Message Bytes

{length bytes} {xferPipe length byte} {xferPipe bytes} {JSON bytes}

• {length bytes}: uint32, 4 bytes, big endian
• {xferPipe length byte}: 1 byte
• {xferPipe bytes}: one byte one xfer
• {JSON bytes}: {"seq":%d,"mtype":%d,"serviceMethod":%q,"status":%q,"meta":%q,"bodyCodec":%d,"body":"%s"}

Usage

import "github.com/fyyang/erpc/v6/proto/jsonproto"

Test

package jsonproto_test

import (
	"testing"
	"time"

	"github.com/fyyang/erpc/v6"
	"github.com/fyyang/erpc/v6/proto/jsonproto"
	"github.com/fyyang/erpc/v6/xfer/gzip"
)

type Home struct {
	erpc.CallCtx
}

func (h *Home) Test(arg *map[string]string) (map[string]interface{}, *erpc.Status) {
	h.Session().Push("/push/test", map[string]string{
		"your_id": string(h.PeekMeta("peer_id")),
	})
	return map[string]interface{}{
		"arg": *arg,
	}, nil
}

func TestJSONProto(t *testing.T) {
	gzip.Reg('g', "gizp-5", 5)

	// Server
	srv := erpc.NewPeer(erpc.PeerConfig{ListenPort: 9090})
	srv.RouteCall(new(Home))
	go srv.ListenAndServe(jsonproto.NewJSONProtoFunc())
	time.Sleep(1e9)

	// Client
	cli := erpc.NewPeer(erpc.PeerConfig{})
	cli.RoutePush(new(Push))
	sess, stat := cli.Dial(":9090", jsonproto.NewJSONProtoFunc())
	if !stat.OK() {
		t.Fatal(stat)
	}
	var result interface{}
	stat = sess.Call("/home/test",
		map[string]string{
			"author": "henrylee2cn",
		},
		&result,
		erpc.WithAddMeta("peer_id", "110"),
		erpc.WithXferPipe('g'),
	).Status()
	if !stat.OK() {
		t.Error(stat)
	}
	t.Logf("result:%v", result)
	time.Sleep(3e9)
}

type Push struct {
	erpc.PushCtx
}

func (p *Push) Test(arg *map[string]string) *erpc.Status {
	erpc.Infof("receive push(%s):\narg: %#v\n", p.IP(), arg)
	return nil
}

test command:

go test -v -run=TestJSONProto

Documentation

Overview

Package jsonproto is implemented JSON socket communication protocol.

Message data format: {length bytes}{xfer_pipe length byte}{xfer_pipe bytes}{JSON bytes}

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

• func NewJSONProtoFunc() erpc.ProtoFunc

Functions

func NewJSONProtoFunc

func NewJSONProtoFunc() erpc.ProtoFunc

NewJSONProtoFunc is creation function of JSON socket protocol.

Message data format: {length bytes}{xfer_pipe length byte}{xfer_pipe bytes}{JSON bytes}
Message data demo: `830{"seq":%q,"mtype":%d,"serviceMethod":%q,"meta":%q,"bodyCodec":%d,"body":"%s"}`