channel

package

v0.0.0-...-b60b6a8 Latest Latest Go to latest Published: Feb 9, 2022 License: Apache-2.0 Imports: 12 Imported by: 0

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/SEI-TAS/docker-slim

Documentation ¶

Index ¶

Constants
Variables
func GenerateTID() string
type Client
- func NewClient(addr string, connectWait, connectTimeout, readTimeout, writeTimeout int) (*Client, error)
- func (c *Client) Close() error
- func (c *Client) Read(retries uint) (*Frame, error)
- func (c *Client) Write(frame *Frame, retries uint) (n int, err error)
type CommandClient
- func NewCommandClient(addr string, connectWait, connectTimeout, readTimeout, writeTimeout int) (*CommandClient, error)
- func (c *CommandClient) Call(data []byte, retries uint) ([]byte, error)
type CommandServer
- func NewCommandServer(addr string, handler RequestHandler) *CommandServer
- func (s *CommandServer) OnConnection(conn net.Conn)
- func (s *CommandServer) SetReqHandler(handler RequestHandler)
type ConnectionHandler
type EventClient
- func NewEventClient(addr string, connectWait, connectTimeout, readTimeout int) (*EventClient, error)
- func (c *EventClient) Next(retries uint) ([]byte, string, error)
type EventServer
- func NewEventServer(addr string) *EventServer
- func (s *EventServer) OnConnection(conn net.Conn)
- func (s *EventServer) Publish(data []byte, retries uint) error
type Frame
type FrameType
type RequestHandler
type Server
- func NewServer(addr string) *Server
- func (s *Server) SetConnHandler(handler ConnectionHandler)
- func (s *Server) Start(async bool) error
- func (s *Server) Stop()

Constants ¶

View Source

const (
	CmdPort = 65501
	EvtPort = 65502
)

Channel ports

Variables ¶

View Source

var (
	ErrNoData           = errors.New("no data")
	ErrFrameTIDMismatch = errors.New("frame TID mismatch")
	ErrFrameUnexpected  = errors.New("unexpected frame type")
	ErrRemoteError      = errors.New("remote error")
	ErrWaitTimeout      = errors.New("wait timeout")
	ErrFrameMalformed   = errors.New("malformed frame")
)

Functions ¶

func GenerateTID ¶

func GenerateTID() string

Types ¶

type Client ¶

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

func NewClient ¶

func NewClient(addr string, connectWait, connectTimeout, readTimeout, writeTimeout int) (*Client, error)

func (*Client) Close ¶

func (c *Client) Close() error

func (*Client) Read ¶

func (c *Client) Read(retries uint) (*Frame, error)

func (*Client) Write ¶

func (c *Client) Write(frame *Frame, retries uint) (n int, err error)

type CommandClient ¶

type CommandClient struct {
	*Client
}

func NewCommandClient ¶

func NewCommandClient(addr string, connectWait, connectTimeout, readTimeout, writeTimeout int) (*CommandClient, error)

func (*CommandClient) Call ¶

func (c *CommandClient) Call(data []byte, retries uint) ([]byte, error)

type CommandServer ¶

type CommandServer struct {
	*Server
	// contains filtered or unexported fields
}

func NewCommandServer ¶

func NewCommandServer(addr string, handler RequestHandler) *CommandServer

func (*CommandServer) OnConnection ¶

func (s *CommandServer) OnConnection(conn net.Conn)

func (*CommandServer) SetReqHandler ¶

func (s *CommandServer) SetReqHandler(handler RequestHandler)

type ConnectionHandler ¶

type ConnectionHandler interface {
	OnConnection(conn net.Conn)
}

type EventClient ¶

type EventClient struct {
	*Client
}

func NewEventClient ¶

func NewEventClient(addr string, connectWait, connectTimeout, readTimeout int) (*EventClient, error)

func (*EventClient) Next ¶

func (c *EventClient) Next(retries uint) ([]byte, string, error)

type EventServer ¶

type EventServer struct {
	*Server
	// contains filtered or unexported fields
}

func NewEventServer ¶

func NewEventServer(addr string) *EventServer

func (*EventServer) OnConnection ¶

func (s *EventServer) OnConnection(conn net.Conn)

func (*EventServer) Publish ¶

func (s *EventServer) Publish(data []byte, retries uint) error

type Frame ¶

type Frame struct {
	TID  string          `json:"tid"`
	Type FrameType       `json:"type"`
	Body json.RawMessage `json:"body,omitempty"`
}

type FrameType ¶

type FrameType string

FrameType is a Frame struct type

const (
	RequestFrameType  FrameType = "ft.request"
	ResponseFrameType FrameType = "ft.response"
	EventFrameType    FrameType = "ft.event"
	ErrorFrameType    FrameType = "ft.error"
	ControlFrameType  FrameType = "ft.control"
)

Supported frame types

type RequestHandler ¶

type RequestHandler interface {
	OnRequest(data []byte) ([]byte, error)
}

type Server ¶

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

func NewServer ¶

func NewServer(addr string) *Server

func (*Server) SetConnHandler ¶

func (s *Server) SetConnHandler(handler ConnectionHandler)

func (*Server) Start ¶

func (s *Server) Start(async bool) error

func (*Server) Stop ¶

func (s *Server) Stop()

Source Files ¶

View all Source files

channel.go

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