pubsub

Documentation

Index

• func Decoder(d DecodeRequestFunc) func(e *Endpoint)
• func MaxExtension(d time.Duration) func(e *Endpoint)
• func MaxOutstandingMessages(n int) func(e *Endpoint)
• func NumGoRoutines(n int) func(e *Endpoint)
• func PopulateRequestContext(ctx context.Context, msg *pubsub.Message) context.Context
• func Synchronous(b bool) func(e *Endpoint)
• type Client
  • func NewClient(ctx context.Context, projectID, topic string, opts ...ClientOption) (*Client, error)
  • func (c *Client) Close() error
  • func (c *Client) Endpoint() endpoint.Endpoint
• type ClientOption
  • func EncodeRequest(er EncodeRequestFunc) ClientOption
  • func SetClient(client *pubsub.Client) ClientOption
• type DecodeRequestFunc
• type EncodeRequestFunc
• type Endpoint
• type EndpointOption
• type Handler
• type Middleware
• type Transport
  • func NewTransport(ctx context.Context, projectID string) *Transport
  • func (t *Transport) Endpoint(subscriptionName string, endpoint endpoint.Endpoint, options ...EndpointOption) *Transport
  • func (*Transport) LogKeys() map[string]interface{}
  • func (t *Transport) Middleware(m Middleware) *Transport
  • func (t *Transport) RegisterEndpoints(m endpoint.Middleware) error
  • func (t *Transport) Shutdown(ctx context.Context) error
  • func (t *Transport) Start(ctx context.Context) error

Functions

func Decoder

func Decoder(d DecodeRequestFunc) func(e *Endpoint)

Decoder sets the decode function for requests in the endpoint

func MaxExtension

func MaxExtension(d time.Duration) func(e *Endpoint)

MaxExtension sets the max extension duration

func MaxOutstandingMessages

func MaxOutstandingMessages(n int) func(e *Endpoint)

MaxOutstandingMessages sets the max outstanding messages

func NumGoRoutines

func NumGoRoutines(n int) func(e *Endpoint)

NumGoRoutines sets the number of Go routines

func PopulateRequestContext

func PopulateRequestContext(ctx context.Context, msg *pubsub.Message) context.Context

PopulateRequestContext is a RequestFunc that populates several values into the context from the pub/sub message. Those values may be extracted using the corresponding ContextKey type in this package.

func Synchronous

func Synchronous(b bool) func(e *Endpoint)

Synchronous sets the synchronous mode

Types

type Client

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

Client defines the attributes of the client

func NewClient

func NewClient(ctx context.Context, projectID, topic string, opts ...ClientOption) (*Client, error)

NewClient creates the client

func (*Client) Close

func (c *Client) Close() error

Close closes the client

func (*Client) Endpoint

func (c *Client) Endpoint() endpoint.Endpoint

Endpoint creates an endpoint

type ClientOption

type ClientOption func(*Client)

ClientOption sets an optional parameter for clients.

func EncodeRequest

func EncodeRequest(er EncodeRequestFunc) ClientOption

EncodeRequest sets the encode request function of the client

func SetClient

func SetClient(client *pubsub.Client) ClientOption

SetClient sets the pubsub client

type DecodeRequestFunc

type DecodeRequestFunc func(context.Context, *pubsub.Message) (interface{}, error)

DecodeRequestFunc is a function to decode pub/sub message and return structured data

type EncodeRequestFunc

type EncodeRequestFunc func(interface{}) ([]byte, error)

EncodeRequestFunc defines the encode request function

type Endpoint

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

Endpoint for this pubsub transport

type EndpointOption

type EndpointOption func(*Endpoint)

EndpointOption is a function to set option in endpoint

type Handler

type Handler func(ctx context.Context, msg *pubsub.Message) error

Handler is a function that processes a Pub/Sub message and returns an error

type Middleware

type Middleware func(Handler) Handler

Middleware is a Pub/Sub middleware

type Transport

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

Transport is a transport that receives requests from PubSub

func NewTransport

func NewTransport(ctx context.Context, projectID string) *Transport

NewTransport creates a new Transport for the related Google Cloud Project

func (*Transport) Endpoint

func (t *Transport) Endpoint(subscriptionName string, endpoint endpoint.Endpoint, options ...EndpointOption) *Transport

Endpoint creates a new Endpoint

func (*Transport) LogKeys

func (*Transport) LogKeys() map[string]interface{}

LogKeys returns the keys for logging

func (*Transport) Middleware

func (t *Transport) Middleware(m Middleware) *Transport

Middleware sets a Pub/Sub middleware for all endpoint handlers

func (*Transport) RegisterEndpoints

func (t *Transport) RegisterEndpoints(m endpoint.Middleware) error

RegisterEndpoints registers a middleware to all registered endpoints at that time

func (*Transport) Shutdown

func (t *Transport) Shutdown(ctx context.Context) error

Shutdown shutdowns the google pubsub client

func (*Transport) Start

func (t *Transport) Start(ctx context.Context) error

Start starts listening to PubSub