libext

README

libext

Library for building arhat extensions in Go

Support Matrix

• Protocols: tcp, tcp-tls, udp, udp-dtls, unix, unix-tls, pipe, pipe-tls
• Codec: json, protobuf

please refer to Benchmark for performance evaluation of different combinations

Usage

Controller for Extension (Client)

TL;DR: create a project using this template: arhat-ext/template-go or have a look at examples/client_example_test.go

Extension Hub (Server)

TL;DR: have a look at examples/server_example_test.go

Benchmark

You can find reference benchmark results in CI log, to run it locally:

make test.benchmark

LICENSE

Copyright 2020 The arhat.dev Authors.

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.

Documentation

Overview

Package libext provides client and controller for creating extension controllers with arhat-proto

Index

• type Client
  • func NewClient(ctx context.Context, kind arhatgopb.ExtensionType, name string, ...) (*Client, error)
  • func (c *Client) ProcessNewStream(cmdCh chan<- *arhatgopb.Cmd, msgCh <-chan *arhatgopb.Msg) error
• type Controller
  • func NewController(ctx context.Context, logger log.Interface, marshal codec.MarshalFunc, ...) (*Controller, error)
  • func (c *Controller) Close()
  • func (c *Controller) RefreshChannels() (cmdCh chan<- *arhatgopb.Cmd, msgCh <-chan *arhatgopb.Msg)
  • func (c *Controller) Start() error

Types

type Client

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

func NewClient

func NewClient(
	ctx context.Context,
	kind arhatgopb.ExtensionType,
	name string,
	c codec.Interface,

	dialer interface{},
	endpointURL string,
	tlsConfig *tls.Config,
) (*Client, error)

func (*Client) ProcessNewStream

func (c *Client) ProcessNewStream(
	cmdCh chan<- *arhatgopb.Cmd,
	msgCh <-chan *arhatgopb.Msg,
) error

ProcessNewStream creates a new connection and handles message stream until connection lost or msgCh closed the provided `cmdCh` and `msgCh` are expected to be freshly created usually this function is used in conjunction with Controller.RefreshChannels

type Controller

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

func NewController

func NewController(
	ctx context.Context,
	logger log.Interface,
	marshal codec.MarshalFunc,
	h types.Handler,
) (*Controller, error)

NewController creates a hub for message send/receive

func (*Controller) Close

func (c *Controller) Close()

Close controller, will not handle incoming commands anymore

func (*Controller) RefreshChannels

func (c *Controller) RefreshChannels() (cmdCh chan<- *arhatgopb.Cmd, msgCh <-chan *arhatgopb.Msg)

RefreshChannels creates a new cmd and msg channel pair for new connection usually this function is called in conjunction with Client.ProcessNewStream

func (*Controller) Start

func (c *Controller) Start() error