Teleport

Teleport is a versatile, high-performance and flexible socket framework.

It can be used for peer-peer, rpc, gateway, micro services, push services, game services and so on.

简体中文

Benchmark

Test Case

• A server and a client process, running on the same machine
• CPU: Intel Xeon E312xx (Sandy Bridge) 16 cores 2.53GHz
• Memory: 16G
• OS: Linux 2.6.32-696.16.1.el6.centos.plus.x86_64, CentOS 6.4
• Go: 1.9.2
• Message size: 581 bytes
• Message codec: protobuf
• Sent total 1000000 messages

Test Results

• teleport

client concurrency	mean(ms)	median(ms)	max(ms)	min(ms)	throughput(TPS)
100	1	0	16	0	75505
500	9	11	97	0	52192
1000	19	24	187	0	50040
2000	39	54	409	0	42551
5000	96	128	1148	0	46367

• teleport/socket

client concurrency	mean(ms)	median(ms)	max(ms)	min(ms)	throughput(TPS)
100	0	0	14	0	225682
500	2	1	24	0	212630
1000	4	3	51	0	180733
2000	8	6	64	0	183351
5000	21	18	651	0	133886

test code

• Profile torch of teleport/socket

svg file

• Heap torch of teleport/socket

svg file

Version

version	status	branch
v3	release	v3
v2	release	v2
v1	release	v1

Install

go get -u -f github.com/henrylee2cn/teleport

Feature

• Server and client are peer-to-peer, have the same API method
• Support custom communication protocol
• Support set the size of socket I/O buffer
• Packet contains both Header and Body two parts
• Packet Header contains metadata in the same format as HTTP header
• Support for customizing Body coding types separately, e.g JSON Protobuf string
• Support push, pull, reply and other means of communication
• Support plug-in mechanism, can customize authentication, heartbeat, micro service registration center, statistics, etc.
• Whether server or client, the peer support reboot and shutdown gracefully
• Support reverse proxy
• Detailed log information, support print input and output details
• Supports setting slow operation alarm threshold
• Use I/O multiplexing technology
• Support setting the size of the reading packet (if exceed disconnect it)
• Provide the context of the handler
• Client session support automatically redials after disconnection
• Support network list: tcp, tcp4, tcp6, unix, unixpacket and so on
• Provide an operating interface to control the connection file descriptor

Example

server.go

package main

import (
    "fmt"
    "time"

    tp "github.com/henrylee2cn/teleport"
)

func main() {
    srv := tp.NewPeer(tp.PeerConfig{
        CountTime:     true,
        ListenAddress: ":9090",
    })
    srv.RoutePull(new(math))
    srv.ListenAndServe()
}

type math struct {
    tp.PullCtx
}

func (m *math) Add(args *[]int) (int, *tp.Rerror) {
    if m.Query().Get("push_status") == "yes" {
        m.Session().Push(
            "/push/status",
            fmt.Sprintf("%d numbers are being added...", len(*args)),
        )
        time.Sleep(time.Millisecond * 10)
    }
    var r int
    for _, a := range *args {
        r += a
    }
    return r, nil
}

client.go

package main

import (
    tp "github.com/henrylee2cn/teleport"
)

func main() {
    tp.SetLoggerLevel("ERROR")
    cli := tp.NewPeer(tp.PeerConfig{})
    defer cli.Close()
    cli.RoutePush(new(push))
    sess, err := cli.Dial(":9090")
    if err != nil {
        tp.Fatalf("%v", err)
    }

    var reply int
    rerr := sess.Pull("/math/add?push_status=yes",
        []int{1, 2, 3, 4, 5},
        &reply,
    ).Rerror()

    if rerr != nil {
        tp.Fatalf("%v", rerr)
    }
    tp.Printf("reply: %d", reply)
}

type push struct {
    tp.PushCtx
}

func (p *push) Status(args *string) *tp.Rerror {
    tp.Printf("server status: %s", *args)
    return nil
}

More Examples

Design

Keywords

• Peer: A communication instance may be a server or a client
• Socket: Base on the net.Conn package, add custom package protocol, transfer pipelines and other functions
• Packet: The corresponding structure of the data package content element
• Proto: The protocol interface of packet pack/unpack
• Codec: Serialization interface for Packet.Body
• XferPipe: Packet bytes encoding pipeline, such as compression, encryption, calibration and so on
• XferFilter: A interface to handle packet data before transfer
• Plugin: Plugins that cover all aspects of communication
• Session: A connection session, with push, pull, reply, close and other methods of operation
• Context: Handle the received or send packets
• Pull-Launch: Pull data from the peer
• Pull-Handle: Handle and reply to the pull of peer
• Push-Launch: Push data to the peer
• Push-Handle: Handle the push of peer
• Router: Router that route the response handler by request information(such as a URI)

Packet

The contents of every one packet:

// in .../teleport/socket package

// Packet a socket data packet.
type Packet struct {
    // Has unexported fields.
}

func GetPacket(settings ...PacketSetting) *Packet
func NewPacket(settings ...PacketSetting) *Packet
func (p *Packet) Body() interface{}
func (p *Packet) BodyCodec() byte
func (p *Packet) Context() context.Context
func (p *Packet) MarshalBody() ([]byte, error)
func (p *Packet) Meta() *utils.Args
func (p *Packet) Ptype() byte
func (p *Packet) Reset(settings ...PacketSetting)
func (p *Packet) Seq() string
func (p *Packet) SetBody(body interface{})
func (p *Packet) SetBodyCodec(bodyCodec byte)
func (p *Packet) SetNewBody(newBodyFunc NewBodyFunc)
func (p *Packet) SetPtype(ptype byte)
func (p *Packet) SetSeq(seq string)
func (p *Packet) SetSize(size uint32) error
func (p *Packet) SetUri(uri string)
func (p *Packet) SetUriObject(uriObject *url.URL)
func (p *Packet) Size() uint32
func (p *Packet) String() string
func (p *Packet) UnmarshalBody(bodyBytes []byte) error
func (p *Packet) Uri() string
func (p *Packet) UriObject() *url.URL
func (p *Packet) XferPipe() *xfer.XferPipe

// NewBodyFunc creates a new body by header.
type NewBodyFunc func(Header) interface{}

Codec

The body's codec set.

type Codec interface {
    // Id returns codec id.
    Id() byte
    // Name returns codec name.
    Name() string
    // Marshal returns the encoding of v.
    Marshal(v interface{}) ([]byte, error)
    // Unmarshal parses the encoded data and stores the result
    // in the value pointed to by v.
    Unmarshal(data []byte, v interface{}) error
}

XferPipe

Transfer filter pipe, handles byte stream of packet when transfer.

// XferFilter handles byte stream of packet when transfer.
type XferFilter interface {
    // Id returns transfer filter id.
    Id() byte
    // Name returns transfer filter name.
    Name() string
    // OnPack performs filtering on packing.
    OnPack([]byte) ([]byte, error)
    // OnUnpack performs filtering on unpacking.
    OnUnpack([]byte) ([]byte, error)
}
// Get returns transfer filter by id.
func Get(id byte) (XferFilter, error)
// GetByName returns transfer filter by name.
func GetByName(name string) (XferFilter, error)

// XferPipe transfer filter pipe, handlers from outer-most to inner-most.
// Note: the length can not be bigger than 255!
type XferPipe struct {
    // Has unexported fields.
}
func NewXferPipe() *XferPipe
func (x *XferPipe) Append(filterId ...byte) error
func (x *XferPipe) AppendFrom(src *XferPipe)
func (x *XferPipe) Ids() []byte
func (x *XferPipe) Len() int
func (x *XferPipe) Names() []string
func (x *XferPipe) OnPack(data []byte) ([]byte, error)
func (x *XferPipe) OnUnpack(data []byte) ([]byte, error)
func (x *XferPipe) Range(callback func(idx int, filter XferFilter) bool)
func (x *XferPipe) Reset()

Plugin

Plug-ins during runtime.

type (
    // Plugin plugin background
    Plugin interface {
        Name() string
    }
    // PreNewPeerPlugin is executed before creating peer.
    PreNewPeerPlugin interface {
        Plugin
        PreNewPeer(*PeerConfig, *PluginContainer) error
    }
    ...
)

Protocol

You can customize your own communication protocol by implementing the interface:

type (
    // Proto pack/unpack protocol scheme of socket packet.
    Proto interface {
        // Version returns the protocol's id and name.
        Version() (byte, string)
        // Pack writes the Packet into the connection.
        // Note: Make sure to write only once or there will be package contamination!
        Pack(*Packet) error
        // Unpack reads bytes from the connection to the Packet.
        // Note: Concurrent unsafe!
        Unpack(*Packet) error
    }
    ProtoFunc func(io.ReadWriter) Proto
)

Next, you can specify the communication protocol in the following ways:

func SetDefaultProtoFunc(socket.ProtoFunc)
type Peer interface {
    ...
    ServeConn(conn net.Conn, protoFunc ...socket.ProtoFunc) Session
    DialContext(ctx context.Context, addr string, protoFunc ...socket.ProtoFunc) (Session, *Rerror)
    Dial(addr string, protoFunc ...socket.ProtoFunc) (Session, *Rerror)
    Listen(protoFunc ...socket.ProtoFunc) error
    ...
}

Default protocol FastProto(Big Endian):

{4 bytes packet length}
{1 byte protocol version}
{1 bytes transfer pipe length}
{transfer pipe IDs}
# The following is handled data by transfer pipe
{4 bytes sequence length}
{sequence}
{1 byte packet type}
{4 bytes URI length}
{URI}
{4 bytes metadata length}
{metadata(urlencoded)}
{1 byte body codec id}
{body}

Usage

Peer(server or client) Demo

// Start a server
var peer1 = tp.NewPeer(tp.PeerConfig{
    ListenAddress: "0.0.0.0:9090", // for server role
})
peer1.Listen()

...

// Start a client
var peer2 = tp.NewPeer(tp.PeerConfig{})
var sess, err = peer2.Dial("127.0.0.1:8080")

Pull-Controller-Struct API template

type Aaa struct {
    tp.PullCtx
}
func (x *Aaa) XxZz(args *<T>) (<T>, *tp.Rerror) {
    ...
    return r, nil
}

• register it to root router:

// register the pull route: /aaa/xx_zz
peer.RoutePull(new(Aaa))

// or register the pull route: /xx_zz
peer.RoutePullFunc((*Aaa).XxZz)

Pull-Handler-Function API template

func XxZz(ctx tp.PullCtx, args *<T>) (<T>, *tp.Rerror) {
    ...
    return r, nil
}

• register it to root router:

// register the pull route: /xx_zz
peer.RoutePullFunc(XxZz)

Push-Controller-Struct API template

type Bbb struct {
    tp.PushCtx
}
func (b *Bbb) YyZz(args *<T>) *tp.Rerror {
    ...
    return nil
}

• register it to root router:

// register the push route: /bbb/yy_zz
peer.RoutePush(new(Bbb))

// or register the push route: /yy_zz
peer.RoutePushFunc((*Bbb).YyZz)

Push-Handler-Function API template

// YyZz register the route: /yy_zz
func YyZz(ctx tp.PushCtx, args *<T>) *tp.Rerror {
    ...
    return nil
}

• register it to root router:

// register the push route: /yy_zz
peer.RoutePushFunc(YyZz)

Unknown-Pull-Handler-Function API template

func XxxUnknownPull (ctx tp.UnknownPullCtx) (interface{}, *tp.Rerror) {
    ...
    return r, nil
}

• register it to root router:

// register the unknown pull route: /*
peer.SetUnknownPull(XxxUnknownPull)

Unknown-Push-Handler-Function API template

func XxxUnknownPush(ctx tp.UnknownPushCtx) *tp.Rerror {
    ...
    return nil
}

• register it to root router:

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

The mapping rule of struct(func) name to URI path:

• AaBb -> /aa_bb
• Aa_Bb -> /aa/bb
• aa_bb -> /aa/bb
• Aa__Bb -> /aa_bb
• aa__bb -> /aa_bb
• ABC_XYZ -> /abc/xyz
• ABcXYz -> /abc_xyz
• ABC__XYZ -> /abc_xyz

Plugin Demo

// NewIgnoreCase Returns a ignoreCase plugin.
func NewIgnoreCase() *ignoreCase {
    return &ignoreCase{}
}

type ignoreCase struct{}

var (
    _ tp.PostReadPullHeaderPlugin = new(ignoreCase)
    _ tp.PostReadPushHeaderPlugin = new(ignoreCase)
)

func (i *ignoreCase) Name() string {
    return "ignoreCase"
}

func (i *ignoreCase) PostReadPullHeader(ctx tp.ReadCtx) *tp.Rerror {
    // Dynamic transformation path is lowercase
    ctx.UriObject().Path = strings.ToLower(ctx.UriObject().Path)
    return nil
}

func (i *ignoreCase) PostReadPushHeader(ctx tp.ReadCtx) *tp.Rerror {
    // Dynamic transformation path is lowercase
    ctx.UriObject().Path = strings.ToLower(ctx.UriObject().Path)
    return nil
}

Register above handler and plugin

// add router group
group := peer.SubRoute("test")
// register to test group
group.RoutePull(new(Aaa), NewIgnoreCase())
peer.RoutePullFunc(XxZz, NewIgnoreCase())
group.RoutePush(new(Bbb))
peer.RoutePushFunc(YyZz)
peer.SetUnknownPull(XxxUnknownPull)
peer.SetUnknownPush(XxxUnknownPush)

Config

type PeerConfig struct {
    Network            string        `yaml:"network"              ini:"network"              comment:"Network; tcp, tcp4, tcp6, unix or unixpacket"`
    ListenAddress      string        `yaml:"listen_address"       ini:"listen_address"       comment:"Listen address; for server role"`
    DefaultDialTimeout time.Duration `yaml:"default_dial_timeout" ini:"default_dial_timeout" comment:"Default maximum duration for dialing; for client role; ns,µs,ms,s,m,h"`
    RedialTimes        int32         `yaml:"redial_times"         ini:"redial_times"         comment:"The maximum times of attempts to redial, after the connection has been unexpectedly broken; for client role"`
    DefaultBodyCodec   string        `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 PULL 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 ..."`
    PrintDetail        bool          `yaml:"print_detail"         ini:"print_detail"         comment:"Is print body and metadata or not"`
    CountTime          bool          `yaml:"count_time"           ini:"count_time"           comment:"Is count cost time or not"`
}

Optimize

• SetPacketSizeLimit sets max packet size. If maxSize<=0, set it to max uint32.

  func SetPacketSizeLimit(maxPacketSize uint32)

• SetSocketKeepAlive sets whether the operating system should send keepalive messages on the connection.

  func SetSocketKeepAlive(keepalive bool)

• SetSocketKeepAlivePeriod sets period between keep alives.

  func SetSocketKeepAlivePeriod(d time.Duration)

• SetSocketNoDelay controls whether the operating system should delay packet transmission in hopes of sending fewer packets (Nagle's algorithm). The default is true (no delay), meaning that data is sent as soon as possible after a Write.

  func SetSocketNoDelay(_noDelay bool)

• SetSocketReadBuffer sets the size of the operating system's receive buffer associated with the connection.

  func SetSocketReadBuffer(bytes int)

• SetSocketWriteBuffer sets the size of the operating system's transmit buffer associated with the connection.

  func SetSocketWriteBuffer(bytes int)

Extensions

Codec

package	import	description
json	import "github.com/henrylee2cn/teleport/codec"	JSON codec(teleport own)
protobuf	import "github.com/henrylee2cn/teleport/codec"	Protobuf codec(teleport own)
plain	import "github.com/henrylee2cn/teleport/codec"	Plain text codec(teleport own)
form	import "github.com/henrylee2cn/teleport/codec"	Form(url encode) codec(teleport own)

Plugin

package	import	description
auth	import "github.com/henrylee2cn/teleport/plugin"	A auth plugin for verifying peer at the first time
binder	import binder "github.com/henrylee2cn/tp-ext/plugin-binder"	Parameter Binding Verification for Struct Handler
heartbeat	import heartbeat "github.com/henrylee2cn/tp-ext/plugin-heartbeat"	A generic timing heartbeat plugin
proxy	import "github.com/henrylee2cn/teleport/plugin"	A proxy plugin for handling unknown pulling or pushing
secure	import secure "github.com/henrylee2cn/tp-ext/plugin-secure"	Encrypting/decrypting the packet body

Protocol

package	import	description
fastproto	import "github.com/henrylee2cn/teleport/socket	A fast socket communication protocol(teleport default protocol)
jsonproto	import jsonproto "github.com/henrylee2cn/tp-ext/proto-jsonproto"	A JSON socket communication protocol
pbproto	import pbproto "github.com/henrylee2cn/tp-ext/proto-pbproto"	A Protobuf socket communication protocol

Transfer-Filter

package	import	description
gzip	import "github.com/henrylee2cn/teleport/xfer"	Gzip(teleport own)
md5Hash	import md5Hash "github.com/henrylee2cn/tp-ext/xfer-md5Hash"	Provides a integrity check transfer filter

Module

package	import	description
cliSession	import cliSession "github.com/henrylee2cn/tp-ext/mod-cliSession"	Client session with a high efficient and load balanced connection pool
websocket	import websocket "github.com/henrylee2cn/tp-ext/mod-websocket"	Makes the Teleport framework compatible with websocket protocol as specified in RFC 6455
html	html "github.com/xiaoenai/ants/helper/mod-html"	HTML render for http client

Extensions Repository

Projects based on Teleport

project	description
TP-Micro	TP-Micro is a simple, powerful micro service framework based on Teleport
Ants	Ants is a highly available micro service platform based on TP-Micro and Teleport
Pholcus	Pholcus is a distributed, high concurrency and powerful web crawler software

Business Users

     

License

Teleport is under Apache v2 License. See the LICENSE file for the full license text