blob: bd581b45f9137680207c88f9b718d527e85670e6 [file] [log] [blame]
// Copyright 2020 Google LLC
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// See the License for the specific language governing permissions and
// limitations under the License.
// Code generated by protoc-gen-go_gapic. DO NOT EDIT.
package pubsublite
import (
gax ""
gtransport ""
pubsublitepb ""
var newSubscriberClientHook clientHook
// SubscriberCallOptions contains the retry settings for each method of SubscriberClient.
type SubscriberCallOptions struct {
Subscribe []gax.CallOption
func defaultSubscriberClientOptions() []option.ClientOption {
return []option.ClientOption{
func defaultSubscriberCallOptions() *SubscriberCallOptions {
return &SubscriberCallOptions{
Subscribe: []gax.CallOption{},
// SubscriberClient is a client for interacting with .
// Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
type SubscriberClient struct {
// Connection pool of gRPC connections to the service.
connPool gtransport.ConnPool
// flag to opt out of default deadlines via GOOGLE_API_GO_EXPERIMENTAL_DISABLE_DEFAULT_DEADLINE
disableDeadlines bool
// The gRPC API client.
subscriberClient pubsublitepb.SubscriberServiceClient
// The call options for this service.
CallOptions *SubscriberCallOptions
// The x-goog-* metadata to be sent with each request.
xGoogMetadata metadata.MD
// NewSubscriberClient creates a new subscriber service client.
// The service that a subscriber client application uses to receive messages
// from subscriptions.
func NewSubscriberClient(ctx context.Context, opts ...option.ClientOption) (*SubscriberClient, error) {
clientOpts := defaultSubscriberClientOptions()
if newSubscriberClientHook != nil {
hookOpts, err := newSubscriberClientHook(ctx, clientHookParams{})
if err != nil {
return nil, err
clientOpts = append(clientOpts, hookOpts...)
disableDeadlines, err := checkDisableDeadlines()
if err != nil {
return nil, err
connPool, err := gtransport.DialPool(ctx, append(clientOpts, opts...)...)
if err != nil {
return nil, err
c := &SubscriberClient{
connPool: connPool,
disableDeadlines: disableDeadlines,
CallOptions: defaultSubscriberCallOptions(),
subscriberClient: pubsublitepb.NewSubscriberServiceClient(connPool),
return c, nil
// Connection returns a connection to the API service.
// Deprecated.
func (c *SubscriberClient) Connection() *grpc.ClientConn {
return c.connPool.Conn()
// Close closes the connection to the API service. The user should invoke this when
// the client is no longer required.
func (c *SubscriberClient) Close() error {
return c.connPool.Close()
// setGoogleClientInfo sets the name and version of the application in
// the `x-goog-api-client` header passed on each request. Intended for
// use by Google-written clients.
func (c *SubscriberClient) setGoogleClientInfo(keyval ...string) {
kv := append([]string{"gl-go", versionGo()}, keyval...)
kv = append(kv, "gapic", versionClient, "gax", gax.Version, "grpc", grpc.Version)
c.xGoogMetadata = metadata.Pairs("x-goog-api-client", gax.XGoogHeader(kv...))
// Subscribe establishes a stream with the server for receiving messages.
func (c *SubscriberClient) Subscribe(ctx context.Context, opts ...gax.CallOption) (pubsublitepb.SubscriberService_SubscribeClient, error) {
ctx = insertMetadata(ctx, c.xGoogMetadata)
opts = append(c.CallOptions.Subscribe[0:len(c.CallOptions.Subscribe):len(c.CallOptions.Subscribe)], opts...)
var resp pubsublitepb.SubscriberService_SubscribeClient
err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error {
var err error
resp, err = c.subscriberClient.Subscribe(ctx, settings.GRPC...)
return err
}, opts...)
if err != nil {
return nil, err
return resp, nil