api

Documentation

Index

• type Client
  • func GetClient(config plugin.Config) Client
• type ClientStatus

Types

type Client

type Client interface {
	plugin.SharingPlugin

	// GetConnectedClient returns the connected client to publish events.
	GetConnectedClient() interface{}
	// RegisterListener register a listener to listen the client status.
	RegisterListener(chan<- ClientStatus)
}

Client is a plugin interface, that defines new clients, such as gRPC client and Kafka client.

func GetClient

func GetClient(config plugin.Config) Client

GetClient gets an initialized client plugin.

type ClientStatus

type ClientStatus int8

ClientStatus represents the status of the client.

const (
	Connected ClientStatus
	Disconnect
)

The client statuses.