Documentation
¶
Index ¶
- Constants
- type Bus
- type BusController
- type BusPublisher
- type BusSubscriber
- type Client
- func (client *Client) EventBus() Bus
- func (client *Client) Start() error
- func (client *Client) Stop()
- func (client *Client) Subscribe(topic string, fn func(interface{}), serverAddr, serverPath string)
- func (client *Client) SubscribeOnce(topic string, fn func(interface{}), serverAddr, serverPath string)
- type ClientArg
- type ClientService
- type EventBus
- func (bus *EventBus) AddMiddleware(middleware *func(string, interface{}) interface{})
- func (bus *EventBus) HasCallback(topic string) bool
- func (bus *EventBus) Publish(topic string, data interface{})
- func (bus *EventBus) RemoveMiddleware(middleware *func(string, interface{}) interface{})
- func (bus *EventBus) Subscribe(topic string, fn func(interface{})) error
- func (bus *EventBus) SubscribeAsync(topic string, fn func(interface{}), transactional bool) error
- func (bus *EventBus) SubscribeOnce(topic string, fn func(interface{})) error
- func (bus *EventBus) SubscribeOnceAsync(topic string, fn func(interface{})) error
- func (bus *EventBus) Unsubscribe(topic string, handler func(interface{})) error
- func (bus *EventBus) UnsubscribeAll(topic string) error
- func (bus *EventBus) WaitAsync()
- type NetworkBus
- type NetworkBusService
- type Server
- type ServerService
- type SubscribeArg
- type SubscribeType
Constants ¶
const (
// PublishService - Client service method
PublishService = "ClientService.PushEvent"
)
const (
// RegisterService - Server subscribe service method
RegisterService = "ServerService.Register"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Bus ¶
type Bus interface {
BusController
BusSubscriber
BusPublisher
}
Bus englobes global (subscribe, publish, control) bus behavior
type BusController ¶
type BusController interface {
AddMiddleware(*func(string, interface{}) interface{})
RemoveMiddleware(*func(string, interface{}) interface{})
HasCallback(topic string) bool
WaitAsync()
}
BusController defines bus control behavior (checking handler's presence, synchronization)
type BusPublisher ¶
type BusPublisher interface {
Publish(topic string, data interface{})
}
BusPublisher defines publishing-related bus behavior
type BusSubscriber ¶
type BusSubscriber interface {
Subscribe(topic string, fn func(interface{})) error
SubscribeAsync(topic string, fn func(interface{}), transactional bool) error
SubscribeOnce(topic string, fn func(interface{})) error
SubscribeOnceAsync(topic string, fn func(interface{})) error
Unsubscribe(topic string, handler func(interface{})) error
UnsubscribeAll(topic string) error
}
BusSubscriber defines subscription-related bus behavior
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client - object capable of subscribing to a remote event bus
func (*Client) SubscribeOnce ¶
func (client *Client) SubscribeOnce(topic string, fn func(interface{}), serverAddr, serverPath string)
SubscribeOnce subscribes once to a topic in a remote event bus
type ClientArg ¶
type ClientArg struct {
Data interface{}
Topic string
}
ClientArg - object containing event for client to publish locally
type ClientService ¶
type ClientService struct {
// contains filtered or unexported fields
}
ClientService - service object listening to events published in a remote event bus
type EventBus ¶
type EventBus struct {
// contains filtered or unexported fields
}
EventBus - box for handlers and callbacks.
func (*EventBus) AddMiddleware ¶
func (*EventBus) HasCallback ¶
HasCallback returns true if exists any callback subscribed to the topic.
func (*EventBus) Publish ¶
Publish executes callback defined for a topic. Any additional argument will be transferred to the callback.
func (*EventBus) RemoveMiddleware ¶
func (*EventBus) Subscribe ¶
Subscribe subscribes to a topic. Returns error if `fn` is not a function.
func (*EventBus) SubscribeAsync ¶
SubscribeAsync subscribes to a topic with an asynchronous callback Transactional determines whether subsequent callbacks for a topic are run serially (true) or concurrently (false) Returns error if `fn` is not a function.
func (*EventBus) SubscribeOnce ¶
SubscribeOnce subscribes to a topic once. Handler will be removed after executing. Returns error if `fn` is not a function.
func (*EventBus) SubscribeOnceAsync ¶
SubscribeOnceAsync subscribes to a topic once with an asynchronous callback Handler will be removed after executing. Returns error if `fn` is not a function.
func (*EventBus) Unsubscribe ¶
Unsubscribe removes callback defined for a topic. Returns error if there are no callbacks subscribed to the topic.
func (*EventBus) UnsubscribeAll ¶
type NetworkBus ¶
NetworkBus - object capable of subscribing to remote event buses in addition to remote event busses subscribing to it's local event bus. Compoed of a server and client
func NewNetworkBus ¶
func NewNetworkBus(address, path string) *NetworkBus
NewNetworkBus - returns a new network bus object at the server address and path
func (*NetworkBus) EventBus ¶
func (networkBus *NetworkBus) EventBus() Bus
EventBus - returns wrapped event bus
func (*NetworkBus) Start ¶
func (networkBus *NetworkBus) Start() error
Start - helper method to serve a network bus service
func (*NetworkBus) Stop ¶
func (networkBus *NetworkBus) Stop()
Stop - signal for the service to stop serving
type NetworkBusService ¶
type NetworkBusService struct {
// contains filtered or unexported fields
}
NetworkBusService - object capable of serving the network bus
type Server ¶
type Server struct {
// contains filtered or unexported fields
}
Server - object capable of being subscribed to by remote handlers
func (*Server) HasClientSubscribed ¶
func (server *Server) HasClientSubscribed(arg *SubscribeArg) bool
HasClientSubscribed - True if a client subscribed to this server with the same topic
type ServerService ¶
type ServerService struct {
// contains filtered or unexported fields
}
ServerService - service object to listen to remote subscriptions
func (*ServerService) Register ¶
func (service *ServerService) Register(arg *SubscribeArg, success *bool) error
Register - Registers a remote handler to this event bus for a remote subscribe - a given client address only needs to subscribe once event will be republished in local event bus
type SubscribeArg ¶
type SubscribeArg struct {
ClientAddr string
ClientPath string
ServiceMethod string
SubscribeType SubscribeType
Topic string
}
SubscribeArg - object to hold subscribe arguments from remote event handlers
type SubscribeType ¶
type SubscribeType int
SubscribeType - how the client intends to subscribe
const ( // Subscribe - subscribe to all events Subscribe SubscribeType = iota // SubscribeOnce - subscribe to only one event SubscribeOnce )
Source Files