subclient

Documentation

Index

• Constants
• Variables
• type Subscriber
  • func New(ctx context.Context, messages chan []byte, u *url.URL, ...) (subscriber *Subscriber, resp *http.Response, err error)
  • func (s *Subscriber) Close() (err error)
  • func (s *Subscriber) Done() (done <-chan struct{})
  • func (s *Subscriber) Error() (err error)
  • func (s *Subscriber) Messages() (messages <-chan []byte)

Constants

const (

	// ClientType is the client type to be specified in the "pubsub" HTTP header.
	ClientType = "subscriber"
)

Variables

var (

	// ErrUnhandledMessageType indicates that an unhandled websocket message type was received.
	ErrUnhandledMessageType = errors.New("an unhandled websocket message type was received")
)

Types

type Subscriber

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

Subscriber represents a pubsub subscriber.

func New

func New(ctx context.Context, messages chan []byte, u *url.URL, options ...clients.Options) (subscriber *Subscriber, resp *http.Response, err error)

New creates a new pubsub.Subscriber. The given ctx is used to close the goroutines launched from this function call.

func (*Subscriber) Close

func (s *Subscriber) Close() (err error)

Close cancels the subscriber's context, ends its goroutines, and websocket.

func (*Subscriber) Done

func (s *Subscriber) Done() (done <-chan struct{})

Done mimics context.Context's Done method.

func (*Subscriber) Error

func (s *Subscriber) Error() (err error)

Error returns the error of why the subscriber closed. It should only be called after the Done method's channel has been closed.

func (*Subscriber) Messages

func (s *Subscriber) Messages() (messages <-chan []byte)

Messages returns the channel to read messages from.