grav

Oct 13, 2022

Changes in this version

+ type BridgeConnection interface

+ Close func()

+ Start func(pod *Pod)

+ type BridgeOptions struct

+ Custom interface{}

+ Logger *vlog.Logger

+ NodeUUID string

+ type BridgeTransport interface

+ ConnectTopic func(topic string) (BridgeConnection, error)

+ Setup func(opts *BridgeOptions) error

type Connection

+ IncomingHandshake func(HandshakeCallback) error

+ OutgoingHandshake func(handshake *TransportHandshake) (*TransportHandshakeAck, error)

+ ReadMsg func() (Message, *Withdraw, error)

+ SendMsg func(msg Message) error

+ SendWithdraw func(*Withdraw) error

+ type MeshOptions struct

+ Custom interface{}

+ Logger *vlog.Logger

+ NodeUUID string

+ Port string

+ URI string

+ type MeshTransport interface

+ Connect func(endpoint string) (Connection, error)

+ Setup func(opts *MeshOptions, connFunc ConnectFunc) error

type Options

+ BridgeTransport BridgeTransport

+ MeshTransport MeshTransport

type OptionsModifier

+ func UseBridgeTransport(bridge BridgeTransport) OptionsModifier

+ func UseMeshTransport(mesh MeshTransport) OptionsModifier

+ type Withdraw struct

+ Ack bool

Feb 16, 2022

Changes in this version

+ var ErrBelongsToMismatch = errors.New("new connection doesn't belongTo the same group or *")

+ var ErrNodeWithdrawn = errors.New("node has withdrawn from the mesh")

+ var ErrTunnelNotEstablished = errors.New("tunnel cannot be established")

type Discovery

+ Stop func() error

type Grav

+ BelongsTo string

+ Interests []string

+ func (g *Grav) Stop() error

+ func (g *Grav) Tunnel(capability string, msg Message) error

+ func (g *Grav) Withdraw() error

+ type HandshakeCallback func(*TransportHandshake) *TransportHandshakeAck

type MsgBuffer

+ func (m *MsgBuffer) Next() Message

type Options

+ BelongsTo string

+ Interests []string

type OptionsModifier

+ func UseBelongsTo(belongsTo string) OptionsModifier

+ func UseInterests(interests ...string) OptionsModifier

type TransportHandshake

+ BelongsTo string

+ Interests []string

type TransportHandshakeAck

+ Accept bool

+ BelongsTo string

+ Interests []string

+ type TransportWithdraw struct

+ UUID string

+ type WithdrawSignaler struct

+ Ctx context.Context

+ DoneChan chan bool

+ func NewSignaler(ctx context.Context) *WithdrawSignaler

Jul 29, 2021

Changes in this version

+ var ErrBridgeOnlyTransport = errors.New("transport only supports bridge connection")

+ var ErrNotBridgeTransport = errors.New("transport is not a bridge")

+ var TransportTypeBridge = TransportType("transport.bridge")

+ var TransportTypeMesh = TransportType("transport.mesh")

type Grav

+ func (g *Grav) ConnectBridgeTopic(topic string) error

+ type TopicConnection interface

+ Close func()

+ Start func(pod *Pod)

type Transport

+ ConnectBridgeTopic func(topic string) (TopicConnection, error)

+ Type func() TransportType

+ type TransportType string

Jun 16, 2021

Changes in this version

+ type MsgBuffer struct

+ func NewMsgBuffer(limit int) *MsgBuffer

+ func (m *MsgBuffer) Iter(msgFunc MsgFunc)

+ func (m *MsgBuffer) Push(msg Message)

Dec 28, 2020

Changes in this version

+ var ErrConnectionClosed = errors.New("connection was closed")

+ var ErrNodeUUIDMismatch = errors.New("handshake UUID did not match node UUID")

+ type Connection interface

+ CanReplace func() bool

+ Close func()

+ DoIncomingHandshake func(handshakeAck *TransportHandshakeAck) (*TransportHandshake, error)

+ DoOutgoingHandshake func(handshake *TransportHandshake) (*TransportHandshakeAck, error)

+ Send func(msg Message) error

+ Start func(recvFunc ReceiveFunc)

+ type DiscoveryFunc func(endpoint string, uuid string)

type DiscoveryOpts

+ TransportURI string

+ type FindFunc func(uuid string) (Connection, bool)

type Options

+ URI string

type OptionsModifier

+ func UseEndpoint(port, uri string) OptionsModifier

+ type ReceiveFunc func(msg Message)

type Transport

+ CreateConnection func(endpoint string) (Connection, error)

+ Setup func(opts *TransportOpts, connFunc ConnectFunc, findFunc FindFunc) error

type TransportOpts

+ URI string

Dec 18, 2020

Changes in this version

+ var ErrNoReceipt = errors.New("message receipt is nil")

+ type MsgReceipt struct

+ UUID string

+ func (m *MsgReceipt) OnReply(mfn MsgFunc) error

+ func (m *MsgReceipt) WaitOn(onFunc MsgFunc) error

+ func (m *MsgReceipt) WaitUntil(timeout TimeoutFunc, onFunc MsgFunc) error

type Pod

+ func (p *Pod) WaitUntil(timeout TimeoutFunc, onFunc MsgFunc) error

+ type TimeoutFunc func() chan time.Time

+ func TO(seconds int) TimeoutFunc

+ func Timeout(seconds int) TimeoutFunc

Nov 22, 2020

Changes in this version

type Pod

+ func (p *Pod) Disconnect()

Oct 30, 2020

Changes in this version

+ const TransportMsgTypeHandshake

+ const TransportMsgTypeUser

+ var ErrWaitTimeout = errors.New("waited past timeout")

+ type Discovery interface

+ Start func(*DiscoveryOpts, Transport, ConnectFunc) error

+ type DiscoveryOpts struct

+ Custom interface{}

+ Logger *vlog.Logger

+ NodeUUID string

+ TransportPort string

type Grav

+ NodeUUID string

type Message

+ func NewMsgReplyTo(ticket MessageTicket, msgType string, data []byte) Message

+ ReplyTo func() string

+ SetReplyTo func(string)

+ Ticket func() MessageTicket

+ type MessageTicket struct

+ UUID string

+ type Options struct

+ Discovery Discovery

+ Logger *vlog.Logger

+ Port string

+ Transport Transport

+ type OptionsModifier func(*Options)

+ func UseDiscovery(discovery Discovery) OptionsModifier

+ func UseLogger(logger *vlog.Logger) OptionsModifier

+ func UsePort(port string) OptionsModifier

+ func UseTransport(transport Transport) OptionsModifier

type Pod

+ func (p *Pod) ReplyTo(ticket MessageTicket, msg Message)

+ func (p *Pod) SendAndWaitOnReply(msg Message, onFunc MsgFunc, timeoutSeconds ...int) error

+ func (p *Pod) WaitOnReply(ticket MessageTicket, onFunc MsgFunc, timeoutSeconds ...int) error

type Transport

+ ConnectEndpointWithUUID func(string, string, ConnectFunc) error

+ type TransportHandshake struct

+ UUID string

+ type TransportHandshakeAck struct

+ UUID string

type TransportOpts

+ NodeUUID string

Sep 6, 2020

Changes in this version

type Grav

+ func (g *Grav) ConnectEndpointWithReplay(endpoint string) error

+ func (g *Grav) ConnectWithReplay() *Pod

Aug 23, 2020

Changes in this version

type TransportServeOpts

+ func DefaultTransportServeOpts() *TransportServeOpts

Aug 23, 2020

Changes in this version

+ type TransportServeOpts struct

+ Custom interface{}

+ Port int

Aug 21, 2020

Changes in this version

type TransportOpts

+ Custom interface{}

+ Logger vlog.Logger

+ Port int

Aug 21, 2020

Changes in this version

+ const MsgTypeDefault

+ type CreateTransportFunc func(*TransportOpts, ConnectFunc) Transport

+ type TransportOpts struct

+ func DefaultTransportOpts() *TransportOpts

Aug 11, 2020

Changes in this version

+ var ErrTransportNotConfigured = errors.New("transport plugin not configured")

+ type ConnectFunc func() *Pod

type Grav

+ func NewWithTransport(tspt Transport) *Grav

+ func (g *Grav) ConnectEndpoint(endpoint string) error

+ func (g *Grav) Serve() error

+ type Transport interface

+ ConnectEndpoint func(string) error

+ Serve func() error

+ UseConnectFunc func(ConnectFunc)

Aug 9, 2020

Changes in this version

+ const DefaultMsgType

+ var ErrMsgNotWanted = errors.New("message not wanted")

+ type Message interface

+ Data func() []byte

+ Marshal func() ([]byte, error)

+ ParentID func() string

+ ResponseTo func() string

+ Timestamp func() time.Time

+ Type func() string

+ UUID func() string

+ Unmarshal func([]byte) error

+ UnmarshalData func(interface{}) error

+ func MsgFromBytes(bytes []byte) (Message, error)

+ func MsgFromRequest(r *http.Request) (Message, error)

+ func NewMsg(msgType string, data []byte) Message

+ func NewMsgResponseTo(msgType, responseTo string, data []byte) Message

+ func NewMsgWithParentID(msgType, parentID string, data []byte) Message

+ type MsgChan chan Message

+ type MsgFunc func(Message) error

+ type Pod struct

+ GroupName string

+ func (mf Pod) FilterType(msgType string, allow bool)

+ func (mf Pod) FilterUUID(uuid string, allow bool)

+ func (p *Pod) On(onFunc MsgFunc)

+ func (p *Pod) OnType(onFunc MsgFunc, msgTypes ...string)

+ func (p *Pod) Send(msg Message)

+ func (p *Pod) WaitOn(onFunc MsgFunc) error

Aug 6, 2020

Changes in this version

+ type Grav struct

+ GroupName string

+ func New() *Grav

+ func (g *Grav) Connect() *pod.Pod