websocket

Documentation

Index

• Constants
• func New(endpoint string, opts ...swarm.Option) (swarm.Broker, error)
• type AuthorizerApiKeyProps
• type AuthorizerJwtProps
• type AuthorizerUniversalProps
• type Broker
  • func NewBroker(scope constructs.Construct, id *string, props *BrokerProps) *Broker
  • func (broker *Broker) NewAuthorizerApiKey(props *AuthorizerApiKeyProps) awsapigatewayv2.IWebSocketRouteAuthorizer
  • func (broker *Broker) NewAuthorizerJwt(props *AuthorizerJwtProps) awsapigatewayv2.IWebSocketRouteAuthorizer
  • func (broker *Broker) NewAuthorizerUniversal(props *AuthorizerUniversalProps) awsapigatewayv2.IWebSocketRouteAuthorizer
  • func (broker *Broker) NewGateway(props *WebSocketApiProps) awsapigatewayv2.WebSocketApi
  • func (broker *Broker) NewSink(props *SinkProps) *Sink
• type BrokerProps
• type Client
  • func NewWebSocket(endpoint string, opts ...swarm.Option) (*Client, error)
  • func (cli *Client) Enq(bag swarm.Bag) error
• type Gateway
• type Sink
  • func NewSink(scope constructs.Construct, id *string, props *SinkProps) *Sink
• type SinkProps
• type WSContext
• type WebSocketApiProps

Constants

const WSRequest = WSContext("WS.Request")

Functions

func New

func New(endpoint string, opts ...swarm.Option) (swarm.Broker, error)

Types

type AuthorizerApiKeyProps

type AuthorizerApiKeyProps struct {
	Access string
	Secret string
}

type AuthorizerJwtProps

type AuthorizerJwtProps struct {
	Issuer   string
	Audience string
}

type AuthorizerUniversalProps

type AuthorizerUniversalProps struct {
	AuthorizerApiKey *AuthorizerApiKeyProps
	AuthorizerJwt    *AuthorizerJwtProps
}

type Broker

type Broker struct {
	constructs.Construct
	Gateway    awsapigatewayv2.WebSocketApi
	Authorizer awsapigatewayv2.IWebSocketRouteAuthorizer
	// contains filtered or unexported fields
}

func NewBroker

func NewBroker(scope constructs.Construct, id *string, props *BrokerProps) *Broker

func (*Broker) NewAuthorizerApiKey

func (broker *Broker) NewAuthorizerApiKey(props *AuthorizerApiKeyProps) awsapigatewayv2.IWebSocketRouteAuthorizer

func (*Broker) NewAuthorizerJwt

func (broker *Broker) NewAuthorizerJwt(props *AuthorizerJwtProps) awsapigatewayv2.IWebSocketRouteAuthorizer

func (*Broker) NewAuthorizerUniversal

func (broker *Broker) NewAuthorizerUniversal(props *AuthorizerUniversalProps) awsapigatewayv2.IWebSocketRouteAuthorizer

func (*Broker) NewGateway

func (broker *Broker) NewGateway(props *WebSocketApiProps) awsapigatewayv2.WebSocketApi

func (*Broker) NewSink

func (broker *Broker) NewSink(props *SinkProps) *Sink

type BrokerProps

type BrokerProps struct {
	System string
}

type Client

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

func NewWebSocket

func NewWebSocket(endpoint string, opts ...swarm.Option) (*Client, error)

func (*Client) Enq

func (cli *Client) Enq(bag swarm.Bag) error

Enq enqueues message to broker

type Gateway

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

WebSocket declares the subset of interface from AWS SDK used by the lib.

type Sink

type Sink struct {
	constructs.Construct
	Handler awslambda.IFunction
}

func NewSink

func NewSink(scope constructs.Construct, id *string, props *SinkProps) *Sink

type SinkProps

type SinkProps struct {
	Route   string
	Lambda  *scud.FunctionGoProps
	Gateway awsapigatewayv2.WebSocketApi
}

type WSContext

type WSContext string

type WebSocketApiProps

type WebSocketApiProps struct {
	*awsapigatewayv2.WebSocketApiProps
	Throttle *awsapigatewayv2.ThrottleSettings
	Host     *string
	TlsArn   *string
}