beam

Documentation

Index

• Variables
• func Copy(s Sender, r Receiver) (int, error)
• func DecodeStream(dst io.Writer, src Receiver, tag string) error
• func EncodeStream(sender Sender, reader io.Reader, tag string)
• func Pipe() (Receiver, Sender)
• type Message
  • func DecodeLibchanMessage(lcm *libchan.Message) (*Message, error)
  • func (m *Message) LibchanMessage() *libchan.Message
• type NopReceiver
  • func (r NopReceiver) Receive(mode int) (*Message, error)
  • func (r NopReceiver) Unwrap() libchan.Receiver
• type NopSender
  • func (s NopSender) Close() error
  • func (s NopSender) Send(msg *Message) (Receiver, error)
  • func (s NopSender) Unwrap() libchan.Sender
• type Object
  • func Obj(dst Sender) *Object
  • func (o *Object) Attach(name string) (in Receiver, out *Object, err error)
  • func (o *Object) Connect() (net.Conn, error)
  • func (o *Object) Error(msg string, args ...interface{}) error
  • func (o *Object) Get() (string, error)
  • func (o *Object) Log(msg string, args ...interface{}) error
  • func (o *Object) Ls() ([]string, error)
  • func (o *Object) Set(vals ...string) error
  • func (o *Object) SetJson(val interface{}) error
  • func (o *Object) Spawn(cmd ...string) (out *Object, err error)
  • func (o *Object) Start() error
  • func (o *Object) Stop() error
  • func (o *Object) Watch() (Receiver, error)
• type Receiver
  • func WrapReceiver(r libchan.Receiver) Receiver
• type Sender
  • func Handler(h func(msg *Message) error) Sender
  • func Task(f func(in Receiver, out Sender)) Sender
  • func WrapSender(s libchan.Sender) Sender
• type Server
  • func NewServer() *Server
  • func (s *Server) Catchall(h Sender) *Server
  • func (s *Server) Close() error
  • func (s *Server) OnAttach(h Sender) *Server
  • func (s *Server) OnError(h Sender) *Server
  • func (s *Server) OnGet(h Sender) *Server
  • func (s *Server) OnLog(h Sender) *Server
  • func (s *Server) OnLs(h Sender) *Server
  • func (s *Server) OnSpawn(h Sender) *Server
  • func (s *Server) OnStart(h Sender) *Server
  • func (s *Server) OnStop(h Sender) *Server
  • func (s *Server) OnVerb(v Verb, h Sender) *Server
  • func (s *Server) Send(msg *Message) (Receiver, error)
  • func (s *Server) Unwrap() libchan.Sender
• type Tree
  • func NewTree() *Tree
  • func (t *Tree) Bind(name string, dst Sender) *Tree
• type Verb
  • func VerbFromString(s string) (Verb, error)
  • func (v Verb) String() string

Variables

var NotImplemented = WrapSender(libchan.Repeater(notImplementedMsg.LibchanMessage()))

var Ret = libchan.Ret

var RetPipe = WrapSender(libchan.RetPipe)

Functions

func Copy

func Copy(s Sender, r Receiver) (int, error)

func DecodeStream

func DecodeStream(dst io.Writer, src Receiver, tag string) error

func EncodeStream

func EncodeStream(sender Sender, reader io.Reader, tag string)

func Pipe

func Pipe() (Receiver, Sender)

Types

type Message

type Message struct {
	Verb
	Args []string
	Ret  Sender
	Att  *os.File
}

func DecodeLibchanMessage

func DecodeLibchanMessage(lcm *libchan.Message) (*Message, error)

func (*Message) LibchanMessage

func (m *Message) LibchanMessage() *libchan.Message

type NopReceiver

type NopReceiver struct{}

func (NopReceiver) Receive

func (r NopReceiver) Receive(mode int) (*Message, error)

func (NopReceiver) Unwrap

func (r NopReceiver) Unwrap() libchan.Receiver

type NopSender

type NopSender struct{}

func (NopSender) Close

func (s NopSender) Close() error

func (NopSender) Send

func (s NopSender) Send(msg *Message) (Receiver, error)

func (NopSender) Unwrap

func (s NopSender) Unwrap() libchan.Sender

type Object

type Object struct {
	Sender
}

func Obj

func Obj(dst Sender) *Object

func (*Object) Attach

func (o *Object) Attach(name string) (in Receiver, out *Object, err error)

func (*Object) Connect

func (o *Object) Connect() (net.Conn, error)

func (*Object) Error

func (o *Object) Error(msg string, args ...interface{}) error

func (*Object) Get

func (o *Object) Get() (string, error)

func (*Object) Log

func (o *Object) Log(msg string, args ...interface{}) error

func (*Object) Ls

func (o *Object) Ls() ([]string, error)

func (*Object) Set

func (o *Object) Set(vals ...string) error

func (*Object) SetJson

func (o *Object) SetJson(val interface{}) error

func (*Object) Spawn

func (o *Object) Spawn(cmd ...string) (out *Object, err error)

func (*Object) Start

func (o *Object) Start() error

func (*Object) Stop

func (o *Object) Stop() error

func (*Object) Watch

func (o *Object) Watch() (Receiver, error)

type Receiver

type Receiver interface {
	Receive(mode int) (*Message, error)
	Unwrap() libchan.Receiver
}

func WrapReceiver

func WrapReceiver(r libchan.Receiver) Receiver

type Sender

type Sender interface {
	Send(msg *Message) (Receiver, error)
	Close() error
	Unwrap() libchan.Sender
}

func Handler

func Handler(h func(msg *Message) error) Sender

func Task

func Task(f func(in Receiver, out Sender)) Sender

func WrapSender

func WrapSender(s libchan.Sender) Sender

type Server

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

func NewServer

func NewServer() *Server

func (*Server) Catchall

func (s *Server) Catchall(h Sender) *Server

func (*Server) Close

func (s *Server) Close() error

func (*Server) OnAttach

func (s *Server) OnAttach(h Sender) *Server

func (*Server) OnError

func (s *Server) OnError(h Sender) *Server

func (*Server) OnGet

func (s *Server) OnGet(h Sender) *Server

func (*Server) OnLog

func (s *Server) OnLog(h Sender) *Server

func (*Server) OnLs

func (s *Server) OnLs(h Sender) *Server

func (*Server) OnSpawn

func (s *Server) OnSpawn(h Sender) *Server

func (*Server) OnStart

func (s *Server) OnStart(h Sender) *Server

func (*Server) OnStop

func (s *Server) OnStop(h Sender) *Server

func (*Server) OnVerb

func (s *Server) OnVerb(v Verb, h Sender) *Server

func (*Server) Send

func (s *Server) Send(msg *Message) (Receiver, error)

func (*Server) Unwrap

func (s *Server) Unwrap() libchan.Sender

type Tree

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

func NewTree

func NewTree() *Tree

func (*Tree) Bind

func (t *Tree) Bind(name string, dst Sender) *Tree

type Verb

type Verb uint32

const (
	Ack Verb = iota
	Attach
	Connect
	Error
	File
	Get
	Log
	Ls
	Set
	Spawn
	Start
	Stop
	Watch
)

func VerbFromString

func VerbFromString(s string) (Verb, error)

func (Verb) String

func (v Verb) String() string