libext

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, endpointURL string, tlsConfig *tls.Config, ...) (*Client, error)
  • func (c *Client) ProcessNewStream(cmdCh chan<- *arhatgopb.Cmd, msgCh <-chan *arhatgopb.Msg) error
• type Codec
• type Controller
  • func NewController(ctx context.Context, name string, logger log.Interface, h Handler) (*Controller, error)
  • func (c *Controller) Close()
  • func (c *Controller) RefreshChannels() (cmdCh chan<- *arhatgopb.Cmd, msgCh <-chan *arhatgopb.Msg)
  • func (c *Controller) Start() error
• type Decoder
• type Encoder
• type ExtensionType
• type Handler

Types

type Client

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

func NewClient

func NewClient(
	ctx context.Context,
	endpointURL string,
	tlsConfig *tls.Config,
	kind ExtensionType,
	codec Codec,
) (*Client, error)

func (*Client) ProcessNewStream

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

type Codec

type Codec interface {
	ContentType() string
	NewEncoder(w io.Writer) Encoder
	NewDecoder(r io.Reader) Decoder
}

type Controller

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

func NewController

func NewController(ctx context.Context, name string, logger log.Interface, h 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)

func (*Controller) Start

func (c *Controller) Start() error

type Decoder

type Decoder interface {
	Decode(out interface{}) error
}

type Encoder

type Encoder interface {
	Encode(any interface{}) error
}

type ExtensionType

type ExtensionType string

const (
	ExtensionPeripheral ExtensionType = "/peripherals"
)

type Handler

type Handler interface {
	HandleCmd(id uint64, kind arhatgopb.CmdType, payload []byte) (proto.Marshaler, error)
}