Method Subscribe

libs/pubsub/pubsub.go:149–163

Subscribe creates a subscription for the given client. An error will be returned to the caller if the context is canceled or if subscription already exist for pair clientID and query. outCapacity can be used to set a capacity for Subscription#Out channel (1 by default). Panics if outCapacity is le

(
	ctx context.Context,
	clientID string,
	query Query,
	outCapacity ...int)

// default). Panics if outCapacity is less than or equal to zero. If you want
// an unbuffered channel, use SubscribeUnbuffered.
func (s *Server) Subscribe(
	ctx context.Context,
	clientID string,
	query Query,
	outCapacity ...int) (*Subscription, error) {
	outCap := 1
	if len(outCapacity) > 0 {
		if outCapacity[0] <= 0 {
			panic("Negative or zero capacity. Use SubscribeUnbuffered if you want an unbuffered channel")
		}
		outCap = outCapacity[0]
	}

	return s.subscribe(ctx, clientID, query, outCap)
}

// SubscribeUnbuffered does the same as Subscribe, except it returns a
// subscription with unbuffered channel. Use with caution as it can freeze the