EventBus

https://pkg.go.dev/github.com/asaskevich/EventBus
Admin
EventBus is a lightweight event bus library for Go that provides publish-subscribe messaging with...
Tokens:31,960
Snippets:518
Trust Score:9.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install EventBus Package

Source: https://pkg.go.dev/github.com/asaskevich/eventBus

Install the EventBus package using the go get command. Ensure Go is installed on your system.

```bash
go get github.com/asaskevich/EventBus

```

--------------------------------

### Server Start Method

Source: https://pkg.go.dev/github.com/asaskevich/eventBus

Starts the server, enabling it to handle incoming client connections and events.

```go
func (server *Server) Start() error
```

--------------------------------

### Client Start Method

Source: https://pkg.go.dev/github.com/asaskevich/eventBus

Starts the client service, enabling it to listen for remote events.

```go
func (client *Client) Start() error
```

--------------------------------

### Server Start

Source: https://pkg.go.dev/github.com/asaskevich/EventBus

Starts the server, enabling it to accept connections and process events.

```APIDOC
## Server.Start

### Description
Start initiates the server, making it ready to listen for incoming client connections and handle event bus operations.

### Signature
```go
func (server *Server) Start() error
```

### Returns
- error: An error if the server fails to start.
```

--------------------------------

### Server.Start

Source: https://pkg.go.dev/github.com/asaskevich/EventBus%40v0.0.0-20200907212545-49d423059eef

Starts the Server service.

```APIDOC
## Server.Start

### Description
Start starts the Server service.

### Signature
```go
func (server *Server) Start() error
```
```

--------------------------------

### Client Start

Source: https://pkg.go.dev/github.com/asaskevich/EventBus

Starts the client service, enabling it to listen to remote events.

```APIDOC
## Client.Start

### Description
Start initiates the client service, allowing it to listen for and process remote events.

### Signature
```go
func (client *Client) Start() error
```

### Returns
- error: An error if the client fails to start.
```

--------------------------------

### Server.Start

Source: https://pkg.go.dev/github.com/Asaskevich/EventBus

Starts the server to listen for incoming connections and events.

```APIDOC
## Start

### Description

Starts the server service to listen for incoming connections and events.

### Signature

```go
func (server *Server) Start() error
```
```

--------------------------------

### NetworkBus Start Method

Source: https://pkg.go.dev/github.com/asaskevich/eventBus

Starts the NetworkBus service, enabling network event handling.

```go
func (networkBus *NetworkBus) Start() error
```

--------------------------------

### Client.Start

Source: https://pkg.go.dev/github.com/Asaskevich/EventBus

Starts the client service, enabling it to listen for remote events.

```APIDOC
## Start

### Description

Starts the client service to listen to remote events.

### Signature

```go
func (client *Client) Start() error
```
```

--------------------------------

### Client.Start

Source: https://pkg.go.dev/github.com/asaskevich/EventBus%40v0.0.0-20200907212545-49d423059eef

Starts the client service to listen to remote events.

```APIDOC
## Client.Start

### Description
Start starts the client service to listen to remote events.

### Signature
```go
func (client *Client) Start() error
```
```

--------------------------------

### Server.Start

Source: https://pkg.go.dev/github.com/asaskevich/Eventbus

Starts the server, enabling remote clients to subscribe to events.

```APIDOC
## Server.Start

### Description
Starts the server, enabling remote clients to subscribe to events.

### Method
func (*Server) Start() error

### Returns
- **error** - An error if the server fails to start, otherwise nil.
```

--------------------------------

### Basic EventBus Usage Example

Source: https://pkg.go.dev/github.com/asaskevich/eventBus

Demonstrates creating an EventBus, subscribing to a topic, publishing an event, and unsubscribing. The calculator function is subscribed to the 'main:calculator' topic.

```go
func calculator(a int, b int) {
	fmt.Printf("%d\n", a + b)
}

func main() {
	bus := EventBus.New();
	bus.Subscribe("main:calculator", calculator);
	bus.Publish("main:calculator", 20, 40);
	bus.Unsubscribe("main:calculator", calculator);
}

```

--------------------------------

### Server.Start

Source: https://pkg.go.dev/github.com/asaskevich/EventBus%40v0.0.0-20200907212545-49d423059eef

Starts the server service, allowing remote clients to subscribe to events.

```APIDOC
## Server.Start

### Description
Start starts a service for remote clients to subscribe to events.

### Method
func (*Server) Start() error
```

--------------------------------

### NetworkBus.Start

Source: https://pkg.go.dev/github.com/asaskevich/EventBus%40v0.0.0-20200907212545-49d423059eef

Starts the NetworkBus service.

```APIDOC
## NetworkBus.Start

### Description
Start starts the NetworkBus service.

### Signature
```go
func (networkBus *NetworkBus) Start() error
```
```

--------------------------------

### NetworkBus.Start

Source: https://pkg.go.dev/github.com/asaskevich/EventBus%40v0.0.0-20200907212545-49d423059eef

Starts the network bus service, enabling it to serve remote clients.

```APIDOC
## NetworkBus.Start

### Description
Start is a helper method to serve a network bus service.

### Method
func (*NetworkBus) Start() error
```

--------------------------------

### NetworkBus Start

Source: https://pkg.go.dev/github.com/asaskevich/EventBus

Starts the NetworkBus service, enabling it to handle network communications.

```APIDOC
## NetworkBus.Start

### Description
Start initiates the NetworkBus, making it ready to send and receive events over the network.

### Signature
```go
func (networkBus *NetworkBus) Start() error
```

### Returns
- error: An error if the NetworkBus fails to start.
```

--------------------------------

### Server for Cross-Process Events

Source: https://pkg.go.dev/github.com/asaskevich/eventBus

Sets up a server to listen for remotely published events. It starts a server on a specified port and path, and can publish events.

```go
func main() {
    server := NewServer(":2010", "/_server_bus_", New())
    server.Start()
    // ...
    server.EventBus().Publish("main:calculator", 4, 6)
    // ...
    server.Stop()
}

```

--------------------------------

### NetworkBus.Start

Source: https://pkg.go.dev/github.com/Asaskevich/EventBus

Starts the NetworkBus service to handle network communications.

```APIDOC
## Start

### Description

Starts the NetworkBus service.

### Signature

```go
func (networkBus *NetworkBus) Start() error
```
```

--------------------------------

### Server Methods

Source: https://pkg.go.dev/github.com/asaskevich/Eventbus

Methods for creating, starting, stopping, and managing clients for a server hosting an event bus.

```APIDOC
## NewServer

### Description
Creates a new Server instance with the specified address, path, and an underlying event bus.

### Signature
```go
func NewServer(address, path string, eventBus Bus) *Server
```

## Server.EventBus

### Description
Returns the underlying event bus instance managed by the server.

### Signature
```go
func (server *Server) EventBus() Bus
```

## Server.HasClientSubscribed

### Description
Checks if a client is subscribed to a particular topic. This method takes a `SubscribeArg` which contains the topic and client information.

### Signature
```go
func (server *Server) HasClientSubscribed(arg *SubscribeArg) bool
```

## Server.Start

### Description
Starts the server, enabling it to accept connections and manage event bus operations.

### Signature
```go
func (server *Server) Start() error
```

## Server.Stop

### Description
Stops the server and its associated event bus services.

### Signature
```go
func (server *Server) Stop()
```
```

--------------------------------

### NetworkBus.Start

Source: https://pkg.go.dev/github.com/asaskevich/Eventbus

Starts the NetworkBus service, enabling it to serve remote clients and subscribe to remote event buses.

```APIDOC
## NetworkBus.Start

### Description
Starts the NetworkBus service, enabling it to serve remote clients and subscribe to remote event buses.

### Method
func (*NetworkBus) Start() error

### Returns
- **error** - An error if the service fails to start, otherwise nil.
```

--------------------------------

### Cross Process Events - Server

Source: https://pkg.go.dev/github.com/asaskevich/EventBus

Demonstrates the server-side setup for handling cross-process events using RPC services.

```APIDOC
## Cross Process Events - Server

### Description
This section describes the server-side component for cross-process event communication.

### Server Setup
```go
func main() {
    server := NewServer(":2010", "/_server_bus_", New())
    server.Start()
    // ...
    server.EventBus().Publish("main:calculator", 4, 6)
    // ...
    server.Stop()
}
```
```

--------------------------------

### Cross-Process EventBus Server

Source: https://pkg.go.dev/github.com/asaskevich/EventBUs

Sets up a server component for cross-process event communication. It starts a server on a specified address and path, and can publish events.

```go
func main() {
    server := NewServer(":2010", "/_server_bus_", New())
    server.Start()
    // ...
    server.EventBus().Publish("main:calculator", 4, 6)
    // ...
    server.Stop()
}


```

--------------------------------

### Cross-Process EventBus Client

Source: https://pkg.go.dev/github.com/asaskevich/EventBUs

Sets up a client component for cross-process event communication. It starts a client, subscribes to remote events, and can be stopped.

```go
func main() {
    client := NewClient(":2015", "/_client_bus_", New())
    client.Start()
    client.Subscribe("main:calculator", calculator, ":2010", "/_server_bus_")
    // ...
    client.Stop()
}


```

--------------------------------

### Client Methods

Source: https://pkg.go.dev/github.com/asaskevich/Eventbus

Provides methods for creating, starting, stopping, and managing subscriptions for a client connected to a remote event bus.

```APIDOC
## NewClient

### Description
Creates a client object with the specified address and server path, connected to the given event bus.

### Signature
```go
func NewClient(address, path string, eventBus Bus) *Client
```

## Client.EventBus

### Description
Returns the underlying event bus instance used by the client.

### Signature
```go
func (client *Client) EventBus() Bus
```

## Client.Start

### Description
Starts the client service, enabling it to listen for remote events.

### Signature
```go
func (client *Client) Start() error
```

## Client.Stop

### Description
Signals the client service to stop serving.

### Signature
```go
func (client *Client) Stop()
```

## Client.Subscribe

### Description
Subscribes to a topic in a remote event bus. Events received on this topic will be delivered to the provided function `fn`.

### Signature
```go
func (client *Client) Subscribe(topic string, fn interface{}, serverAddr, serverPath string)
```

## Client.SubscribeOnce

### Description
Subscribes once to a topic in a remote event bus. The subscription will be automatically removed after the first event is received and delivered to the provided function `fn`.

### Signature
```go
func (client *Client) SubscribeOnce(topic string, fn interface{}, serverAddr, serverPath string)
```
```

--------------------------------

### Cross Process Events - Client

Source: https://pkg.go.dev/github.com/asaskevich/EventBus

Demonstrates the client-side setup for subscribing to remotely published events using RPC services.

```APIDOC
## Cross Process Events - Client

### Description
This section describes the client-side component for subscribing to cross-process events.

### Client Setup
```go
func main() {
    client := NewClient(":2015", "/_client_bus_", New())
    client.Start()
    client.Subscribe("main:calculator", calculator, ":2010", "/_server_bus_")
    // ...
    client.Stop()
}
```
```

--------------------------------

### NetworkBus Methods

Source: https://pkg.go.dev/github.com/asaskevich/Eventbus

Methods for creating, starting, stopping, and accessing the event bus for a network-connected bus.

```APIDOC
## NewNetworkBus

### Description
Creates a new NetworkBus instance with the specified address and path.

### Signature
```go
func NewNetworkBus(address, path string) *NetworkBus
```

## NetworkBus.EventBus

### Description
Returns the underlying event bus instance managed by the NetworkBus.

### Signature
```go
func (networkBus *NetworkBus) EventBus() Bus
```

## NetworkBus.Start

### Description
Starts the NetworkBus service, enabling it to handle network communication for events.

### Signature
```go
func (networkBus *NetworkBus) Start() error
```

## NetworkBus.Stop

### Description
Stops the NetworkBus service.

### Signature
```go
func (networkBus *NetworkBus) Stop()
```
```

--------------------------------

### New Server Constructor

Source: https://pkg.go.dev/github.com/asaskevich/eventBus

Creates a new Server instance configured with a specific address, path, and an underlying EventBus.

```go
func NewServer(address, path string, eventBus Bus) *Server
```

--------------------------------

### NewServer

Source: https://pkg.go.dev/github.com/asaskevich/EventBus%40v0.0.0-20200907212545-49d423059eef

Creates a new Server instance.

```APIDOC
## NewServer

### Description
NewServer creates a new Server with the specified address, path, and event bus.

### Signature
```go
func NewServer(address, path string, eventBus Bus) *Server
```

### Parameters
- **address** (string) - Required - The network address for the server.
- **path** (string) - Required - The path for the server service.
- **eventBus** (Bus) - Required - The event bus instance to be used by the server.
```

--------------------------------

### Client for Cross-Process Events

Source: https://pkg.go.dev/github.com/asaskevich/eventBus

Sets up a client to listen to remotely published events from a server. It connects to a server and subscribes to topics.

```go
func main() {
    client := NewClient(":2015", "/_client_bus_", New())
    client.Start()
    client.Subscribe("main:calculator", calculator, ":2010", "/_server_bus_")
    // ...
    client.Stop()
}

```

--------------------------------

### New Client Constructor

Source: https://pkg.go.dev/github.com/asaskevich/eventBus

Creates a new client object for interacting with a remote event bus.

```go
func NewClient(address, path string, eventBus Bus) *Client
```

--------------------------------

### ServerService Register Method

Source: https://pkg.go.dev/github.com/asaskevich/eventBus

Handles the registration of a client's subscription request on the server.

```go
func (service *ServerService) Register(arg *SubscribeArg, success *bool) error
```

--------------------------------

### Server Methods

Source: https://pkg.go.dev/github.com/asaskevich/eventbus

Methods for setting up and managing an event bus server.

```APIDOC
## Server

### Description
Represents a server that hosts an event bus and manages client connections.

### Methods

#### `NewServer(address, path string, eventBus Bus) *Server`

- **Description**: Creates a new server instance with the specified network address, path, and an underlying event bus.
- **Parameters**:
  - `address` (string) - The network address for the server.
  - `path` (string) - The path for the server.
  - `eventBus` (Bus) - The event bus instance to be used by the server.
- **Returns**:
  - `*Server` - A pointer to the newly created server.

#### `EventBus() Bus`

- **Description**: Returns the underlying event bus instance managed by the server.
- **Returns**:
  - `Bus` - The event bus instance.

#### `HasClientSubscribed(arg *SubscribeArg) bool`

- **Description**: Checks if a client is subscribed to a topic based on the provided subscription arguments.
- **Parameters**:
  - `arg` (*SubscribeArg) - The subscription arguments to check.
- **Returns**:
  - `bool` - `true` if a client is subscribed, `false` otherwise.

#### `Start() error`

- **Description**: Starts the server, enabling it to listen for incoming connections and manage events.
- **Returns**:
  - `error` - An error if the server fails to start.

#### `Stop()`

- **Description**: Signals the server to stop its operations.
```

--------------------------------

### Server Methods

Source: https://pkg.go.dev/github.com/asaskevich/EventBUs

Methods for creating and managing a Server, which listens for remote subscriptions.

```APIDOC
## Server

Server - object capable of being subscribed to by remote handlers.

### Constructors

#### NewServer

```go
func NewServer(address, path string, eventBus Bus) *Server
```

NewServer - create a new Server at the address and path.

### Methods

#### EventBus

```go
func (server *Server) EventBus() Bus
```

EventBus - returns wrapped event bus.

#### HasClientSubscribed

```go
func (server *Server) HasClientSubscribed(arg *SubscribeArg) bool
```

HasClientSubscribed - True if a client subscribed to this server with the same topic.

#### Start

```go
func (server *Server) Start() error
```

Start - starts a service for remote clients to subscribe to events.

#### Stop

```go
func (server *Server) Stop()
```

Stop - signal for the service to stop serving.
```

--------------------------------

### Server.NewServer

Source: https://pkg.go.dev/github.com/Asaskevich/EventBus

Creates a new Server instance to manage event bus connections and operations.

```APIDOC
## NewServer

### Description

Create a new Server with the specified address, path, and event bus.

### Signature

```go
func NewServer(address, path string, eventBus Bus) *Server
```
```

--------------------------------

### Client SubscribeOnce Method

Source: https://pkg.go.dev/github.com/asaskevich/eventBus

Subscribes the client to a topic on a remote event bus, triggering the handler only once.

```go
func (client *Client) SubscribeOnce(topic string, fn interface{}, serverAddr, serverPath string)
```

--------------------------------

### Server NewServer

Source: https://pkg.go.dev/github.com/asaskevich/EventBus

Creates a new Server instance associated with an event bus.

```APIDOC
## NewServer

### Description
NewServer creates a new Server instance, binding it to the provided address, path, and event bus.

### Signature
```go
func NewServer(address, path string, eventBus Bus) *Server
```

### Parameters
- **address** (string) - The network address for the server.
- **path** (string) - The communication path for the server.
- **eventBus** (Bus) - The event bus instance to be used by the server.
```

--------------------------------

### NewServer

Source: https://pkg.go.dev/github.com/asaskevich/Eventbus

Creates a new Server instance, which can be subscribed to by remote handlers. It wraps an EventBus.

```APIDOC
## NewServer

### Description
Creates a new Server instance, which can be subscribed to by remote handlers. It wraps an EventBus.

### Method
func NewServer(address, path string, eventBus Bus) *Server

### Parameters
#### Path Parameters
- **address** (string) - Required - The network address for the server.
- **path** (string) - Required - The path for the server service.
- **eventBus** (Bus) - Required - The EventBus instance to wrap.

### Returns
- **Server** - A pointer to the newly created Server object.
```

--------------------------------

### Server Methods

Source: https://pkg.go.dev/github.com/asaskevich/EventBus

Methods for creating and managing a server for remote event subscriptions.

```APIDOC
## Server

Server - object capable of being subscribed to by remote handlers 

### NewServer

```go
func NewServer(address, path string, eventBus Bus) *Server
```

NewServer - create a new Server at the address and path 

### EventBus

```go
func (server *Server) EventBus() Bus
```

EventBus - returns wrapped event bus 

### HasClientSubscribed

```go
func (server *Server) HasClientSubscribed(arg *SubscribeArg) bool
```

HasClientSubscribed - True if a client subscribed to this server with the same topic 

### Start

```go
func (server *Server) Start() error
```

Start - starts a service for remote clients to subscribe to events 

### Stop

```go
func (server *Server) Stop()
```

Stop - signal for the service to stop serving
```

--------------------------------

### Import EventBus Package

Source: https://pkg.go.dev/github.com/asaskevich/EventBUs

Import the EventBus package into your Go project. An alias can be used for brevity.

```go
import "github.com/asaskevich/EventBus"

```

```go
import (
	evbus "github.com/asaskevich/EventBus"
)

```

--------------------------------

### New EventBus Instance

Source: https://pkg.go.dev/github.com/asaskevich/eventBus

Creates a new instance of the EventBus with no initial handlers.

```go
func New() Bus
```

--------------------------------

### Create New EventBus Instance

Source: https://pkg.go.dev/github.com/asaskevich/eventBus

Instantiate a new EventBus with empty handlers using the New() method.

```go
bus := EventBus.New();

```

--------------------------------

### Import EventBus Package

Source: https://pkg.go.dev/github.com/asaskevich/eventBus

Import the EventBus package into your Go project. You can use the full name or an alias.

```go
import "github.com/asaskevich/EventBus"

```

```go
import (
	evus "github.com/asaskevich/EventBus"
)

```

--------------------------------

### EventBus Initialization

Source: https://pkg.go.dev/github.com/asaskevich/EventBUs

Provides methods for creating new instances of the EventBus and NetworkBus.

```APIDOC
## New EventBus

### Description
Creates a new EventBus with empty handlers.

### Function Signature
```go
func New() Bus
```

## New NetworkBus

### Description
Creates a new NetworkBus instance, which facilitates communication over a network.

### Function Signature
```go
func NewNetworkBus(address, path string) *NetworkBus
```
```

--------------------------------

### Server Operations

Source: https://pkg.go.dev/github.com/asaskevich/EventBUs

Documentation for setting up and managing servers that host event buses and handle client connections.

```APIDOC
## NewServer

### Description
Creates a new server object that hosts an event bus and manages client connections.

### Function Signature
```go
func NewServer(address, path string, eventBus Bus) *Server
```

## Server.EventBus

### Description
Returns the underlying event bus instance managed by the server.

### Function Signature
```go
func (server *Server) EventBus() Bus
```

## Server.Start

### Description
Starts the server, making it ready to accept client connections and handle events.

### Function Signature
```go
func (server *Server) Start() error
```

## Server.Stop

### Description
Stops the server, closing all client connections and ceasing event handling.

### Function Signature
```go
func (server *Server) Stop()
```

## Server.HasClientSubscribed

### Description
Checks if a client is currently subscribed to a specific topic on the server's event bus.

### Function Signature
```go
func (server *Server) HasClientSubscribed(arg *SubscribeArg) bool
```
```

--------------------------------

### New NetworkBus Constructor

Source: https://pkg.go.dev/github.com/asaskevich/eventBus

Initializes a new NetworkBus with the specified address and path for network communication.

```go
func NewNetworkBus(address, path string) *NetworkBus
```

--------------------------------

### Server Methods

Source: https://pkg.go.dev/github.com/asaskevich/eventbus

Methods for creating and managing a Server, which allows remote clients to subscribe to events.

```APIDOC
## NewServer

### Description
Creates a new Server instance at the specified address and path, associated with a given EventBus.

### Method
func NewServer(address, path string, eventBus Bus) *Server

### Parameters
#### Path Parameters
- **address** (string) - The network address for the server.
- **path** (string) - The path for the server service.
- **eventBus** (Bus) - The EventBus instance to be wrapped by the server.

### Response
#### Success Response (*Server)
- A pointer to the newly created Server object.

```

```APIDOC
## Server.EventBus

### Description
Returns the underlying EventBus instance managed by the Server.

### Method
func (server *Server) EventBus() Bus

### Response
#### Success Response (Bus)
- The wrapped EventBus instance.

```

```APIDOC
## Server.HasClientSubscribed

### Description
Checks if any client is subscribed to the server with the same topic as specified in the SubscribeArg.

### Method
func (server *Server) HasClientSubscribed(arg *SubscribeArg) bool

### Parameters
#### Path Parameters
- **arg** (*SubscribeArg) - The subscription arguments to check against.

### Response
#### Success Response (bool)
- **true** if a client is subscribed with the matching topic, **false** otherwise.

```

```APIDOC
## Server.Start

### Description
Starts the Server service, enabling remote clients to subscribe to events.

### Method
func (server *Server) Start() error

### Response
#### Success Response (error)
- **nil** if the service started successfully, an error otherwise.

```

```APIDOC
## Server.Stop

### Description
Signals the Server service to stop serving remote subscriptions.

### Method
func (server *Server) Stop()

```

--------------------------------

### NewClient

Source: https://pkg.go.dev/github.com/asaskevich/EventBus%40v0.0.0-20200907212545-49d423059eef

Creates a new client object with the specified address and server path.

```APIDOC
## NewClient

### Description
NewClient creates a client object with the address and server path.

### Signature
```go
func NewClient(address, path string, eventBus Bus) *Client
```

### Parameters
- **address** (string) - Required - The network address of the event bus server.
- **path** (string) - Required - The path to the event bus service on the server.
- **eventBus** (Bus) - Required - The event bus instance to use for communication.
```

--------------------------------

### NewServer

Source: https://pkg.go.dev/github.com/asaskevich/EventBus%40v0.0.0-20200907212545-49d423059eef

Creates a new Server object that can be subscribed to by remote handlers.

```APIDOC
## NewServer

### Description
NewServer creates a new Server at the address and path, associated with the provided EventBus.

### Method
func NewServer(address, path string, eventBus Bus) *Server

### Parameters
#### Path Parameters
- **address** (string) - Required - The address for the server.
- **path** (string) - Required - The path for the server service.
- **eventBus** (Bus) - Required - The EventBus instance to be wrapped by the server.
```

--------------------------------

### Client EventBus Method

Source: https://pkg.go.dev/github.com/asaskevich/eventBus

Returns the underlying event bus instance used by the client.

```go
func (client *Client) EventBus() Bus
```

--------------------------------

### Client Subscribe Method

Source: https://pkg.go.dev/github.com/asaskevich/eventBus

Subscribes the client to a specified topic on a remote event bus.

```go
func (client *Client) Subscribe(topic string, fn interface{}, serverAddr, serverPath string)
```

--------------------------------

### ServerService Methods

Source: https://pkg.go.dev/github.com/asaskevich/eventbus

Methods for the server-side service that handles client registrations.

```APIDOC
## ServerService

### Description
Represents a service on the server side responsible for handling client subscription registrations.

### Methods

#### `Register(arg *SubscribeArg, success *bool) error`

- **Description**: Registers a client's subscription request. It takes subscription arguments and updates a success boolean.
- **Parameters**:
  - `arg` (*SubscribeArg) - The subscription arguments for the client.
  - `success` (*bool) - A pointer to a boolean that will be updated to indicate if the registration was successful.
- **Returns**:
  - `error` - An error if the registration fails.
```

--------------------------------

### ClientService PushEvent Method

Source: https://pkg.go.dev/github.com/asaskevich/eventBus

An exported service method for clients to push events, intended for listening to remote events.

```go
func (service *ClientService) PushEvent(arg *ClientArg, reply *bool) error
```

--------------------------------

### New EventBus

Source: https://pkg.go.dev/github.com/asaskevich/EventBus

Creates a new EventBus instance with empty handlers.

```APIDOC
## New

### Description
New returns new EventBus with empty handlers.

### Signature
```go
func New() Bus
```
```

--------------------------------

### Server EventBus Method

Source: https://pkg.go.dev/github.com/asaskevich/eventBus

Returns the EventBus instance associated with this server.

```go
func (server *Server) EventBus() Bus
```

--------------------------------

### New()

Source: https://pkg.go.dev/github.com/asaskevich/EventBUs

Creates and returns a new EventBus instance with an empty set of handlers.

```APIDOC
## New()

### Description
Creates and returns a new EventBus instance with an empty set of handlers.

### Code Example
```go
bus := EventBus.New();
```
```

--------------------------------

### New()

Source: https://pkg.go.dev/github.com/asaskevich/eventBus

Creates and returns a new EventBus instance with an empty set of handlers.

```APIDOC
## New()

### Description
Creates and returns a new EventBus instance with an empty set of handlers.

### Usage
```go
bus := EventBus.New()
```
```

--------------------------------

### Client Methods

Source: https://pkg.go.dev/github.com/asaskevich/eventbus

Methods for interacting with a remote event bus as a client.

```APIDOC
## Client

### Description
Represents a client that can connect to and interact with a remote event bus.

### Methods

#### `NewClient(address, path string, eventBus Bus) *Client`

- **Description**: Creates a new client instance configured with the specified network address, server path, and an underlying event bus.
- **Parameters**:
  - `address` (string) - The network address of the remote event bus server.
  - `path` (string) - The path on the server to connect to.
  - `eventBus` (Bus) - The local event bus instance to use.
- **Returns**:
  - `*Client` - A pointer to the newly created client.

#### `EventBus() Bus`

- **Description**: Returns the underlying event bus instance associated with this client.
- **Returns**:
  - `Bus` - The event bus instance.

#### `Start() error`

- **Description**: Starts the client service, enabling it to listen for and process remote events.
- **Returns**:
  - `error` - An error if the client fails to start.

#### `Stop()`

- **Description**: Signals the client service to stop its operations.

#### `Subscribe(topic string, fn interface{}, serverAddr, serverPath string)`

- **Description**: Subscribes to a topic on a remote event bus. The subscription is established through the specified server address and path.
- **Parameters**:
  - `topic` (string) - The topic to subscribe to on the remote bus.
  - `fn` (interface{}) - The handler function to execute when an event is received.
  - `serverAddr` (string) - The address of the remote server.
  - `serverPath` (string) - The path on the remote server.

#### `SubscribeOnce(topic string, fn interface{}, serverAddr, serverPath string)`

- **Description**: Subscribes to a topic on a remote event bus, ensuring the handler function is called only once. The subscription is established through the specified server address and path.
- **Parameters**:
  - `topic` (string) - The topic to subscribe to on the remote bus.
  - `fn` (interface{}) - The handler function to execute once when an event is received.
  - `serverAddr` (string) - The address of the remote server.
  - `serverPath` (string) - The path on the remote server.
```

--------------------------------

### Publish an Event with Arguments

Source: https://pkg.go.dev/github.com/asaskevich/eventBus

Publish an event to a topic, passing any additional arguments to the subscribed callback functions. The Handler function expects a string argument.

```go
func Handler(str string) { ... }
...
bus.Subscribe("topic:handler", Handler)
...
bus.Publish("topic:handler", "Hello, World!");

```

--------------------------------

### ServerService.Register

Source: https://pkg.go.dev/github.com/asaskevich/EventBus%40v0.0.0-20200907212545-49d423059eef

Registers a client subscription with the server.

```APIDOC
## ServerService.Register

### Description
Register exports a service method to register a client subscription.

### Signature
```go
func (service *ServerService) Register(arg *SubscribeArg, success *bool) error
```

### Parameters
#### Request Body
- **arg** (*SubscribeArg) - Required - The subscription argument containing topic information.
- **success** (*bool) - Required - A boolean to indicate if the registration was successful.
```

--------------------------------

### New EventBus

Source: https://pkg.go.dev/github.com/asaskevich/Eventbus

Creates a new instance of the EventBus with empty handlers.

```APIDOC
## New

### Description
Creates a new EventBus instance with empty handlers.

### Signature
```go
func New() Bus
```
```

--------------------------------

### New EventBus

Source: https://pkg.go.dev/github.com/Asaskevich/EventBus

Creates a new instance of the EventBus with empty handlers.

```APIDOC
## New

### Description

Returns new EventBus with empty handlers.

### Signature

```go
func New() Bus
```
```

--------------------------------

### SubscribeOnceAsync(topic string, args ...interface{})

Source: https://pkg.go.dev/github.com/asaskevich/Eventbus

SubscribeOnceAsync works like SubscribeOnce except the callback is executed asynchronously.

```APIDOC
## SubscribeOnceAsync(topic string, args ...interface{})

### Description
SubscribeOnceAsync works like SubscribeOnce except the callback to executed asynchronously.

### Parameters
- **topic** (string) - The topic to subscribe to.
- **args** (...interface{}) - Arguments to pass to the callback.

### Note
This method signature appears incomplete in the source documentation. It is listed as `SubscribeOnceAsync(topic string, args ...interface{})` but the callback function `fn` is missing, which is typically required for subscription methods.
```

--------------------------------

### ServerService.Register

Source: https://pkg.go.dev/github.com/Asaskevich/EventBus

Registers a client's subscription with the server.

```APIDOC
## Register

### Description

Registers a client's subscription with the server.

### Signature

```go
func (service *ServerService) Register(arg *SubscribeArg, success *bool) error
```
```

--------------------------------

### ClientService Methods

Source: https://pkg.go.dev/github.com/asaskevich/Eventbus

Exposes methods for the client service, primarily for pushing events.

```APIDOC
## ClientService.PushEvent

### Description
An exported service method for the client to push events. This is typically used for internal communication or by the server to relay events to clients.

### Signature
```go
func (service *ClientService) PushEvent(arg *ClientArg, reply *bool) error
```
```

--------------------------------

### ClientService Methods

Source: https://pkg.go.dev/github.com/asaskevich/eventbus

Methods for the client-side service that handles pushing events.

```APIDOC
## ClientService

### Description
Represents a service on the client side that listens for events published on a remote event bus.

### Methods

#### `PushEvent(arg *ClientArg, reply *bool) error`

- **Description**: An exported service method used for pushing events. It receives event arguments and updates a reply boolean.
- **Parameters**:
  - `arg` (*ClientArg) - The event arguments to push.
  - `reply` (*bool) - A pointer to a boolean that will be updated based on the operation's success.
- **Returns**:
  - `error` - An error if the event push fails.
```

--------------------------------

### ServerService Methods

Source: https://pkg.go.dev/github.com/asaskevich/EventBUs

Methods for the ServerService, which handles remote subscription registration.

```APIDOC
## ServerService

ServerService - service object to listen to remote subscriptions.

### Methods

#### Register

```go
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; the event will be republished in the local event bus.
```

--------------------------------

### Server Methods

Source: https://pkg.go.dev/github.com/asaskevich/eventBus

Methods for managing a Server, which allows remote handlers to subscribe to events.

```APIDOC
## Server

### Description
Server is an object capable of being subscribed to by remote handlers.

### Constructor

#### NewServer

##### Description
Creates a new Server at the given address and path.

##### Signature
`func NewServer(address, path string, eventBus Bus) *Server`

### Methods

#### EventBus

##### Description
Returns the wrapped event bus.

##### Signature
`func (server *Server) EventBus() Bus`

#### HasClientSubscribed

##### Description
Returns true if a client is subscribed to this server with the same topic.

##### Signature
`func (server *Server) HasClientSubscribed(arg *SubscribeArg) bool`

#### Start

##### Description
Starts a service for remote clients to subscribe to events.

##### Signature
`func (server *Server) Start() error`

#### Stop

##### Description
Signals the service to stop serving.

##### Signature
`func (server *Server) Stop()`
```

--------------------------------

### Client.NewClient

Source: https://pkg.go.dev/github.com/Asaskevich/EventBus

Creates a new client object to interact with a remote event bus.

```APIDOC
## NewClient

### Description

Create a client object with the address and server path.

### Signature

```go
func NewClient(address, path string, eventBus Bus) *Client
```
```

--------------------------------

### Server Stop Method

Source: https://pkg.go.dev/github.com/asaskevich/eventBus

Stops the server, gracefully shutting down its operations.

```go
func (server *Server) Stop()
```

--------------------------------

### Client Stop Method

Source: https://pkg.go.dev/github.com/asaskevich/eventBus

Signals the client service to stop its operations.

```go
func (client *Client) Stop()
```

--------------------------------

### Server.EventBus

Source: https://pkg.go.dev/github.com/asaskevich/EventBus%40v0.0.0-20200907212545-49d423059eef

Returns the underlying EventBus instance wrapped by the Server.

```APIDOC
## Server.EventBus

### Description
EventBus returns the wrapped event bus.

### Method
func (*Server) EventBus() Bus
```

--------------------------------

### Server.EventBus

Source: https://pkg.go.dev/github.com/asaskevich/Eventbus

Returns the underlying EventBus instance wrapped by the Server.

```APIDOC
## Server.EventBus

### Description
Returns the underlying EventBus instance wrapped by the Server.

### Method
func (*Server) EventBus() Bus

### Returns
- **Bus** - The wrapped EventBus instance.
```

--------------------------------

### Client Operations

Source: https://pkg.go.dev/github.com/asaskevich/EventBUs

Details on creating and managing clients for subscribing to remote event buses.

```APIDOC
## NewClient

### Description
Creates a new client object to connect to a remote event bus.

### Function Signature
```go
func NewClient(address, path string, eventBus Bus) *Client
```

## Client.EventBus

### Description
Returns the underlying event bus instance associated with the client.

### Function Signature
```go
func (client *Client) EventBus() Bus
```

## Client.Start

### Description
Starts the client service, enabling it to listen for remote events.

### Function Signature
```go
func (client *Client) Start() error
```

## Client.Stop

### Description
Signals the client service to stop serving and disconnect.

### Function Signature
```go
func (client *Client) Stop()
```

## Client.Subscribe

### Description
Subscribes to a topic on a remote event bus. Events published to this topic will be received by the client.

### Function Signature
```go
func (client *Client) Subscribe(topic string, fn interface{}, serverAddr, serverPath string)
```

## Client.SubscribeOnce

### Description
Subscribes once to a topic on a remote event bus. The subscription is automatically removed after the first event is received.

### Function Signature
```go
func (client *Client) SubscribeOnce(topic string, fn interface{}, serverAddr, serverPath string)
```
```

--------------------------------

### EventBus Publisher Interface

Source: https://pkg.go.dev/github.com/asaskevich/eventBus

Defines the behavior for publishing events on the bus.

```go
type BusPublisher interface {
	Publish(topic string, args ...interface{})
}
```

--------------------------------

### ServerService Methods

Source: https://pkg.go.dev/github.com/asaskevich/EventBus

Methods for the server service to handle remote subscriptions.

```APIDOC
## ServerService

ServerService - service object to listen to remote subscriptions 

### Register

```go
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
```

--------------------------------

### ServerService Methods

Source: https://pkg.go.dev/github.com/asaskevich/eventBus

Methods for the ServerService, which listens to remote subscriptions and registers them.

```APIDOC
## ServerService

### Description
ServerService is a service object to listen to remote subscriptions.

### Methods

#### Register

##### Description
Registers a remote handler to this event bus for a remote subscribe. A given client address only needs to subscribe once; the event will be republished in the local event bus.

##### Signature
`func (service *ServerService) Register(arg *SubscribeArg, success *bool) error`
```

--------------------------------

### EventBus SubscribeOnce Method

Source: https://pkg.go.dev/github.com/asaskevich/eventBus

Subscribes a handler function to a topic, ensuring it is called only once.

```go
func (bus *EventBus) SubscribeOnce(topic string, fn interface{}) error
```

--------------------------------

### Cross Process Events

Source: https://pkg.go.dev/github.com/asaskevich/eventBus

Details on how to set up EventBus for cross-process communication using RPC services.

```APIDOC
## Cross Process Events

### Description
EventBus supports cross-process communication through two RPC services: a client service for listening to remote events and a server service for handling client subscriptions.

### Server Setup
```go
func main() {
    server := NewServer(":2010", "/_server_bus_", New())
    server.Start()
    // ...
    server.EventBus().Publish("main:calculator", 4, 6)
    // ...
    server.Stop()
}
```

### Client Setup
```go
func main() {
    client := NewClient(":2015", "/_client_bus_", New())
    client.Start()
    client.Subscribe("main:calculator", calculator, ":2010", "/_server_bus_")
    // ...
    client.Stop()
}
```
```

--------------------------------

### Server Service

Source: https://pkg.go.dev/github.com/asaskevich/eventBus

Handles the service logic for servers, specifically registering subscriptions.

```APIDOC
## ServerService

### Description
Provides the service interface for servers to register subscriptions.

### Methods
- `Register(arg *SubscribeArg, success *bool) error`: Registers a subscription request from a client.
```

--------------------------------

### ClientArg Struct

Source: https://pkg.go.dev/github.com/asaskevich/eventBus

Represents an event payload for a client, containing the topic and arguments.

```go
type ClientArg struct {
	Args  []interface{}
	Topic string
}
```

--------------------------------

### NewNetworkBus

Source: https://pkg.go.dev/github.com/asaskevich/EventBus%40v0.0.0-20200907212545-49d423059eef

Creates a new NetworkBus instance.

```APIDOC
## NewNetworkBus

### Description
NewNetworkBus creates a new NetworkBus with the specified address and path.

### Signature
```go
func NewNetworkBus(address, path string) *NetworkBus
```

### Parameters
- **address** (string) - Required - The network address for the bus.
- **path** (string) - Required - The path for the bus service.
```

--------------------------------

### Server Type Definition

Source: https://pkg.go.dev/github.com/asaskevich/eventBus

Defines the Server structure, which allows remote handlers to subscribe to local events.

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

--------------------------------

### Client.SubscribeOnce

Source: https://pkg.go.dev/github.com/asaskevich/EventBus%40v0.0.0-20200907212545-49d423059eef

Subscribes once to a topic in a remote event bus.

```APIDOC
## Client.SubscribeOnce

### Description
SubscribeOnce subscribes once to a topic in a remote event bus.

### Signature
```go
func (client *Client) SubscribeOnce(topic string, fn interface{}, serverAddr, serverPath string)
```

### Parameters
- **topic** (string) - Required - The topic to subscribe to.
- **fn** (interface{}) - Required - The handler function to be called.
- **serverAddr** (string) - Required - The address of the remote server.
- **serverPath** (string) - Required - The path to the event bus on the remote server.
```

--------------------------------

### Publish()

Source: https://pkg.go.dev/github.com/asaskevich/eventBus

Publishes an event to a topic, executing all subscribed callbacks. Additional arguments are passed to the callbacks.

```APIDOC
## Publish(topic string, args ...interface{})

### Description
Publishes an event to a topic, executing all subscribed callbacks. Any additional arguments provided will be transferred to the callbacks.

### Parameters
- **topic** (string) - The topic to publish the event to.
- **args** (...interface{}) - Variable number of arguments to pass to the subscribed callbacks.

### Usage
```go
func Handler(str string) { ... }
bus.Subscribe("topic:handler", Handler)
bus.Publish("topic:handler", "Hello, World!")
```
```

--------------------------------

### Client Functionality

Source: https://pkg.go.dev/github.com/asaskevich/eventBus

Enables clients to connect to a remote event bus, subscribe to topics, and manage their subscriptions.

```APIDOC
## Client

### Description
Represents a client that can connect to a remote event bus, subscribe to topics, and receive events.

### Methods
- `NewClient(address, path string, eventBus Bus) *Client`: Creates a new client instance.
- `EventBus() Bus`: Returns the underlying event bus of the client.
- `Start() error`: Starts the client service to listen to remote events.
- `Stop()`: Stops the client service.
- `Subscribe(topic string, fn interface{}, serverAddr, serverPath string)`: Subscribes to a topic in a remote event bus.
- `SubscribeOnce(topic string, fn interface{}, serverAddr, serverPath string)`: Subscribes once to a topic in a remote event bus.
```

--------------------------------

### NetworkBus Methods

Source: https://pkg.go.dev/github.com/asaskevich/EventBus

Methods for creating and managing a network-aware event bus.

```APIDOC
## 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 

### NewNetworkBus

```go
func NewNetworkBus(address, path string) *NetworkBus
```

NewNetworkBus - returns a new network bus object at the server address and path 

### EventBus

```go
func (networkBus *NetworkBus) EventBus() Bus
```

EventBus - returns wrapped event bus 

### Start

```go
func (networkBus *NetworkBus) Start() error
```

Start - helper method to serve a network bus service 

### Stop

```go
func (networkBus *NetworkBus) Stop()
```

Stop - signal for the service to stop serving
```

--------------------------------

### Client Service Structure

Source: https://pkg.go.dev/github.com/asaskevich/eventbus

Represents a service object that listens to events published on a remote event bus. It acts as a receiver for distributed events.

```go
type ClientService struct {
	// contains filtered or unexported fields
}
```

--------------------------------

### ServerService Methods

Source: https://pkg.go.dev/github.com/asaskevich/eventbus

Methods for managing remote subscriptions through the ServerService.

```APIDOC
## ServerService.Register

### Description
Registers a remote handler to this event bus for a remote subscribe. A given client address only needs to subscribe once; the event will be republished in the local event bus.

### Method
func (service *ServerService) Register(arg *SubscribeArg, success *bool) error

### Parameters
#### Path Parameters
- **arg** (*SubscribeArg) - The subscription arguments from the remote handler.
- **success** (*bool) - A pointer to a boolean that will be set to indicate the success of the registration.

### Response
#### Success Response (error)
- **nil** if the registration is successful, an error otherwise.

```

--------------------------------

### Publish Event

Source: https://pkg.go.dev/github.com/Asaskevich/EventBus

Publishes an event to the bus with a given topic and arguments. Any subscribers to this topic will be notified.

```go
Publish(topic string, args ...interface{})
```

--------------------------------

### Subscribe to a Topic Once

Source: https://pkg.go.dev/github.com/asaskevich/eventBus

Subscribe a handler function to a topic that will be executed only once. The handler is automatically removed after execution. Returns an error if the handler is not a function.

```go
func HelloWorld() { ... }
...
bus.SubscribeOnce("topic:handler", HelloWorld)

```

--------------------------------

### Server Functionality

Source: https://pkg.go.dev/github.com/asaskevich/eventBus

Allows servers to manage client subscriptions and handle incoming event publishing requests.

```APIDOC
## Server

### Description
Represents a server that manages client subscriptions and can handle event publishing.

### Methods
- `NewServer(address, path string, eventBus Bus) *Server`: Creates a new server instance.
- `EventBus() Bus`: Returns the underlying event bus of the server.
- `HasClientSubscribed(arg *SubscribeArg) bool`: Checks if a client is subscribed to a topic.
- `Start() error`: Starts the server.
- `Stop()`: Stops the server.
```

--------------------------------

### Server Service Register

Source: https://pkg.go.dev/github.com/asaskevich/EventBus

Exports a service method for servers to register subscriptions, indicating whether the registration was successful.

```APIDOC
## ServerService.Register

### Description
Register is an exported service method for handling subscription requests.

### Signature
```go
func (service *ServerService) Register(arg *SubscribeArg, success *bool) error
```

### Parameters
#### Request Body
- **arg** (*SubscribeArg) - Description of the subscription request.
- **success** (*bool) - Description of the success status of the registration.
```

--------------------------------

### EventBus Publish Method

Source: https://pkg.go.dev/github.com/asaskevich/eventBus

Publishes events to a specified topic, delivering them to all subscribed handlers.

```go
func (bus *EventBus) Publish(topic string, args ...interface{})
```

--------------------------------

### Publish(topic string, args ...interface{})

Source: https://pkg.go.dev/github.com/asaskevich/EventBUs

Publishes an event to a given topic, executing all subscribed callback functions. Any additional arguments provided are passed directly to the callbacks.

```APIDOC
## Publish(topic string, args ...interface{})

### Description
Publishes an event to a given topic, executing all subscribed callback functions. Any additional arguments provided are passed directly to the callbacks.

### Parameters
#### Path Parameters
- **topic** (string) - Required - The topic to publish the event to.
- **args** (...interface{}) - Optional - Additional arguments to pass to the subscribed callbacks.

### Code Example
```go
func Handler(str string) { ... }
...
bus.Subscribe("topic:handler", Handler)
...
bus.Publish("topic:handler", "Hello, World!");
```
```

--------------------------------

### Client Service

Source: https://pkg.go.dev/github.com/asaskevich/eventBus

Handles the service logic for clients, specifically pushing events to the bus.

```APIDOC
## ClientService

### Description
Provides the service interface for clients to push events.

### Methods
- `PushEvent(arg *ClientArg, reply *bool) error`: Exports a service method for listening to remote events.
```

--------------------------------

### Client.Subscribe

Source: https://pkg.go.dev/github.com/asaskevich/EventBus%40v0.0.0-20200907212545-49d423059eef

Subscribes to a topic in a remote event bus.

```APIDOC
## Client.Subscribe

### Description
Subscribe subscribes to a topic in a remote event bus.

### Signature
```go
func (client *Client) Subscribe(topic string, fn interface{}, serverAddr, serverPath string)
```

### Parameters
- **topic** (string) - Required - The topic to subscribe to.
- **fn** (interface{}) - Required - The handler function to be called.
- **serverAddr** (string) - Required - The address of the remote server.
- **serverPath** (string) - Required - The path to the event bus on the remote server.
```
Tokens:
Raw