libext

package module

v0.2.0 Latest Latest Go to latest Published: Nov 1, 2020 License: Apache-2.0 Imports: 16 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/arhat-dev/libext-go

README ¶

libext

Library for building arhat extensions in Go

Examples

TL;DR, create a project using this template: template-arhat-ext-go

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 ¶

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, h types.Handler) (*Controller, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Client ¶

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

func NewClient ¶

func NewClient(
	ctx context.Context,
	kind arhatgopb.ExtensionType,
	name string,
	codec types.Codec,

	dialer *net.Dialer,
	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,
	h types.Handler,
) (*Controller, error)

NewController creates a hub for message send/receive

func (*Controller) Close ¶

func (c *Controller) Close()

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

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
codecjson
codecpb
extperipheral
server
types
util

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL