alephzero

package module
v0.0.0-...-14b750b Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 11, 2021 License: Unlicense Imports: 4 Imported by: 0

README

Aleph Zero: Go

CI codecov

TODO: What is it? Why is it? Who is it????

See https://github.com/alephzero/playground for examples.

Install Instructions

Install AlephZero first: https://github.com/alephzero/alephzero

Then:

go get github.com/alephzero/go

Documentation

Index

Constants

View Source
const (
	A0_OK              = C.A0_OK
	A0_ERR_SYS         = C.A0_ERR_SYS
	A0_ERR_CUSTOM_MSG  = C.A0_ERR_CUSTOM_MSG
	A0_ERR_INVALID_ARG = C.A0_ERR_INVALID_ARG
	A0_ERR_RANGE       = C.A0_ERR_RANGE
	A0_ERR_AGAIN       = C.A0_ERR_AGAIN
	A0_ERR_ITER_DONE   = C.A0_ERR_ITER_DONE
	A0_ERR_NOT_FOUND   = C.A0_ERR_NOT_FOUND
	A0_ERR_FRAME_LARGE = C.A0_ERR_FRAME_LARGE
	A0_ERR_BAD_TOPIC   = C.A0_ERR_BAD_TOPIC
)
View Source
const (
	INIT_OLDEST      ReaderInit = C.A0_INIT_OLDEST
	INIT_MOST_RECENT            = C.A0_INIT_MOST_RECENT
	INIT_AWAIT_NEW              = C.A0_INIT_AWAIT_NEW
)

Variables

This section is empty.

Functions

func FileRemove

func FileRemove(path string) error

func FileRemoveAll

func FileRemoveAll(path string) error

func PacketDepKey

func PacketDepKey() string

Types

type Arena

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

func (Arena) Buf

func (arena Arena) Buf() []byte

func (Arena) Mode

func (arena Arena) Mode() ArenaMode

type ArenaMode

type ArenaMode C.a0_arena_mode_t
const (
	MODE_SHARED    ArenaMode = C.A0_ARENA_MODE_SHARED
	MODE_EXCLUSIVE ArenaMode = C.A0_ARENA_MODE_EXCLUSIVE
	MODE_READONLY  ArenaMode = C.A0_ARENA_MODE_READONLY
)

type File

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

func FileOpen

func FileOpen(path string, opts *FileOptions) (file File, err error)

func (File) Arena

func (file File) Arena() Arena

func (*File) Close

func (file *File) Close() error

func (File) Fd

func (file File) Fd() int

func (File) Path

func (file File) Path() string

type FileOptions

type FileOptions struct {
	CreateOptions struct {
		Size    int
		Mode    int
		DirMode int
	}

	OpenOptions struct {
		ArenaMode ArenaMode
	}
}

func MakeDefaultFileOptions

func MakeDefaultFileOptions() (opts FileOptions)

type Middleware

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

func AddStandardHeaders

func AddStandardHeaders() Middleware

func AddTimeMonoHeader

func AddTimeMonoHeader() Middleware

func AddTimeWallHeader

func AddTimeWallHeader() Middleware

func AddTransportSeqHeader

func AddTransportSeqHeader() Middleware

func AddWriterIdHeader

func AddWriterIdHeader() Middleware

func AddWriterSeqHeader

func AddWriterSeqHeader() Middleware

type Packet

type Packet struct {
	Id      string
	Headers map[string][]string
	Payload []byte
}

func NewPacket

func NewPacket(headers map[string][]string, payload []byte) (pkt Packet)

func ReaderReadOne

func ReaderReadOne(file File, init ReaderInit, flags int) (pkt Packet, err error)

func SubscriberReadOne

func SubscriberReadOne(topic PubSubTopic, init ReaderInit, flags int) (pkt Packet, err error)

type PrpcClient

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

func NewPrpcClient

func NewPrpcClient(topic PrpcTopic) (rc *PrpcClient, err error)

func (*PrpcClient) Cancel

func (rc *PrpcClient) Cancel(reqId string) error

func (*PrpcClient) Close

func (rc *PrpcClient) Close() (err error)

func (*PrpcClient) Connect

func (rc *PrpcClient) Connect(pkt Packet, progressCb func(Packet, bool)) error

type PrpcConnection

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

func (*PrpcConnection) Packet

func (conn *PrpcConnection) Packet() Packet

func (*PrpcConnection) Send

func (conn *PrpcConnection) Send(resp Packet, done bool) error

type PrpcServer

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

func NewPrpcServer

func NewPrpcServer(topic PrpcTopic, onconnect func(PrpcConnection), oncancel func(string)) (ps *PrpcServer, err error)

func (*PrpcServer) Close

func (ps *PrpcServer) Close() (err error)

type PrpcTopic

type PrpcTopic struct {
	Name        string
	FileOptions *FileOptions
}

type PubSubTopic

type PubSubTopic struct {
	Name        string
	FileOptions *FileOptions
}

type Publisher

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

func NewPublisher

func NewPublisher(topic PubSubTopic) (p *Publisher, err error)

func (*Publisher) Close

func (p *Publisher) Close() error

func (*Publisher) Pub

func (p *Publisher) Pub(pkt Packet) error

type Reader

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

func NewReader

func NewReader(arena Arena, init ReaderInit, iter ReaderIter, callback func(Packet)) (r *Reader, err error)

func (*Reader) Close

func (r *Reader) Close() (err error)

type ReaderInit

type ReaderInit int

type ReaderIter

type ReaderIter int
const (
	ITER_NEXT   ReaderIter = C.A0_ITER_NEXT
	ITER_NEWEST            = C.A0_ITER_NEWEST
)

type ReaderSync

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

func NewReaderSync

func NewReaderSync(arena Arena, init ReaderInit, iter ReaderIter) (rs *ReaderSync, err error)

func (*ReaderSync) Close

func (rs *ReaderSync) Close() (err error)

func (*ReaderSync) HasNext

func (rs *ReaderSync) HasNext() (hasNext bool, err error)

func (*ReaderSync) Next

func (rs *ReaderSync) Next() (pkt Packet, err error)

type RpcClient

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

func NewRpcClient

func NewRpcClient(topic RpcTopic) (rc *RpcClient, err error)

func (*RpcClient) Cancel

func (rc *RpcClient) Cancel(reqId string) error

func (*RpcClient) Close

func (rc *RpcClient) Close() (err error)

func (*RpcClient) Send

func (rc *RpcClient) Send(pkt Packet, replyCb func(Packet)) error

type RpcRequest

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

func (*RpcRequest) Packet

func (req *RpcRequest) Packet() Packet

func (*RpcRequest) Reply

func (req *RpcRequest) Reply(resp Packet) error

type RpcServer

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

func NewRpcServer

func NewRpcServer(topic RpcTopic, onrequest func(RpcRequest), oncancel func(string)) (rs *RpcServer, err error)

func (*RpcServer) Close

func (rs *RpcServer) Close() (err error)

type RpcTopic

type RpcTopic struct {
	Name        string
	FileOptions *FileOptions
}

type Subscriber

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

func NewSubscriber

func NewSubscriber(topic PubSubTopic, init ReaderInit, iter ReaderIter, callback func(Packet)) (s *Subscriber, err error)

func (*Subscriber) Close

func (s *Subscriber) Close() (err error)

type SubscriberSync

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

func NewSubscriberSync

func NewSubscriberSync(topic PubSubTopic, init ReaderInit, iter ReaderIter) (ss *SubscriberSync, err error)

func (*SubscriberSync) Close

func (ss *SubscriberSync) Close() (err error)

func (*SubscriberSync) HasNext

func (ss *SubscriberSync) HasNext() (hasNext bool, err error)

func (*SubscriberSync) Next

func (ss *SubscriberSync) Next() (pkt Packet, err error)

type Writer

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

func NewWriter

func NewWriter(arena Arena) (w *Writer, err error)

func (*Writer) Close

func (w *Writer) Close() error

func (*Writer) Push

func (w *Writer) Push(m Middleware) error

func (*Writer) Wrap

func (w *Writer) Wrap(m Middleware) (w2 Writer, err error)

func (*Writer) Write

func (w *Writer) Write(pkt Packet) error

Jump to

Keyboard shortcuts

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