ws

Documentation

Index

• type APIGatewayManagementClient
• type AuthenticatedMessage
• type ConnectionLookup
• type Handler
  • func NewHandler(disconnectHandler, authHandler, pingHandler RouteHandler) *Handler
  • func (h *Handler) Handle(ctx context.Context, request events.APIGatewayWebsocketProxyRequest) (events.APIGatewayProxyResponse, error)
• type Message
• type Pusher
  • func NewPusher(client APIGatewayManagementClient, connectionLookup ConnectionLookup) *Pusher
  • func (p *Pusher) Broadcast(ctx context.Context, driverID int64, actionType string, payload any) error
  • func (p *Pusher) Disconnect(ctx context.Context, connectionID string)
  • func (p *Pusher) Push(ctx context.Context, connectionID string, actionType string, payload any) (bool, error)
• type RouteHandler
• type RouteHandlerFunc
  • func (r RouteHandlerFunc) HandleRequest(ctx context.Context, request events.APIGatewayWebsocketProxyRequest) (events.APIGatewayProxyResponse, error)

Types

type APIGatewayManagementClient

type APIGatewayManagementClient interface {
	PostToConnection(ctx context.Context, params *apigatewaymanagementapi.PostToConnectionInput, optFns ...func(*apigatewaymanagementapi.Options)) (*apigatewaymanagementapi.PostToConnectionOutput, error)
	DeleteConnection(ctx context.Context, params *apigatewaymanagementapi.DeleteConnectionInput, optFns ...func(*apigatewaymanagementapi.Options)) (*apigatewaymanagementapi.DeleteConnectionOutput, error)
}

type AuthenticatedMessage

type AuthenticatedMessage struct {
	Action   string `json:"action"`
	DriverID int64  `json:"driverId"`
}

AuthenticatedMessage is a message that includes the driver ID for auth verification

type ConnectionLookup

type ConnectionLookup interface {
	GetConnectionsByDriver(ctx context.Context, driverID int64) ([]store.WebSocketConnection, error)
}

type Handler

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

func NewHandler

func NewHandler(disconnectHandler, authHandler, pingHandler RouteHandler) *Handler

func (*Handler) Handle

func (h *Handler) Handle(ctx context.Context, request events.APIGatewayWebsocketProxyRequest) (events.APIGatewayProxyResponse, error)

type Message

type Message struct {
	Action  string `json:"action"`
	Payload any    `json:"payload,omitempty"`
}

type Pusher

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

func NewPusher

func NewPusher(client APIGatewayManagementClient, connectionLookup ConnectionLookup) *Pusher

func (*Pusher) Broadcast

func (p *Pusher) Broadcast(ctx context.Context, driverID int64, actionType string, payload any) error

Broadcast sends a message to all active connections for a given driver.

func (*Pusher) Disconnect

func (p *Pusher) Disconnect(ctx context.Context, connectionID string)

Disconnect closes a WebSocket connection.

func (*Pusher) Push

func (p *Pusher) Push(ctx context.Context, connectionID string, actionType string, payload any) (bool, error)

Push dispatches messages in a consistent format. When the connection is valid true, nil will be returned, but if the message could not be delivered due to the connection being disconnected false, nil will be returned.

type RouteHandler

type RouteHandler interface {
	HandleRequest(ctx context.Context, request events.APIGatewayWebsocketProxyRequest) (events.APIGatewayProxyResponse, error)
}

type RouteHandlerFunc

type RouteHandlerFunc func(ctx context.Context, request events.APIGatewayWebsocketProxyRequest) (events.APIGatewayProxyResponse, error)

func (RouteHandlerFunc) HandleRequest

func (r RouteHandlerFunc) HandleRequest(ctx context.Context, request events.APIGatewayWebsocketProxyRequest) (events.APIGatewayProxyResponse, error)