localproxy

package

v0.2.0 Latest Latest Go to latest Published: May 23, 2023 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation ¶

Index ¶

Constants
type AllocateEvent
type BaseEvent
- func (b *BaseEvent) Type() EventType
type Client
- func New(host string, serverID int64, chanError chan<- error) (*Client, error)
type DeallocateEvent
type Event
type EventType

Constants ¶

const (
	// AllocateEventType represents an event received by the server when it is allocated.
	AllocateEventType = EventType("AllocateEventType")

	// DeallocateEventType represents an event received by the server when it is deallocated.
	DeallocateEventType = EventType("DeallocateEventType")
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type AllocateEvent ¶

type AllocateEvent struct {
	*BaseEvent
	AllocationID string `json:"AllocationID"`
}

AllocateEvent represents the data received on an allocation event.

type BaseEvent ¶

type BaseEvent struct {
	Typ      EventType `json:"EventType"`
	EventID  string    `json:"EventID"`
	ServerID int64     `json:"ServerID"`
}

BaseEvent represents the base structure of all events received by the subscriber.

func (*BaseEvent) Type ¶

func (b *BaseEvent) Type() EventType

Type returns the type of the event.

type Client ¶

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

Client represents a client to the local proxy.

func New ¶

func New(host string, serverID int64, chanError chan<- error) (*Client, error)

New constructs a new instance of the local proxy client.

func (*Client) OnPublish ¶

func (c *Client) OnPublish(_ *centrifuge.Subscription, e centrifuge.PublishEvent)

OnPublish implements centrifuge.PublishHandler and is triggered when a message is published to this subscriber.

func (*Client) OnSubscribeError ¶

func (c *Client) OnSubscribeError(_ *centrifuge.Subscription, _ centrifuge.SubscribeErrorEvent)

OnSubscribeError implements centrifuge.SubscribeErrorHandler and is triggered when an error is encountered with this subscriber.

func (*Client) OnSubscribeSuccess ¶

func (c *Client) OnSubscribeSuccess(_ *centrifuge.Subscription, _ centrifuge.SubscribeSuccessEvent)

OnSubscribeSuccess implements centrifuge.SubscribeSuccessHandler and is triggered when the client has successfully subscribed to the broker.

func (*Client) RegisterCallback ¶

func (c *Client) RegisterCallback(ev EventType, cb func(Event))

RegisterCallback registers a callback function for the specified EventType.

func (*Client) Start ¶

func (c *Client) Start() error

Start subscribes to the centrifuge broker and connects to it. Start() blocks until the client has subscribed successfully.

func (*Client) Stop ¶

func (c *Client) Stop() error

Stop stops the client.

type DeallocateEvent ¶

type DeallocateEvent struct {
	*BaseEvent
	AllocationID string `json:"AllocationID"`
}

DeallocateEvent represents the data received on a deallocation event.

type Event ¶

type Event interface {
	Type() EventType
}

Event represents the interface for any event received by the subscriber.

type EventType ¶

type EventType string

EventType is a type alias for an event received by the subscriber.

Source Files ¶

View all Source files

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