github.com/confluentinc/confluent-kafka-go@v1.9.2/kafka/context.go (about)

     1  /**
     2   * Copyright 2019 Confluent Inc.
     3   *
     4   * Licensed under the Apache License, Version 2.0 (the "License");
     5   * you may not use this file except in compliance with the License.
     6   * You may obtain a copy of the License at
     7   *
     8   * http://www.apache.org/licenses/LICENSE-2.0
     9   *
    10   * Unless required by applicable law or agreed to in writing, software
    11   * distributed under the License is distributed on an "AS IS" BASIS,
    12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13   * See the License for the specific language governing permissions and
    14   * limitations under the License.
    15   */
    16  
    17  package kafka
    18  
    19  import (
    20  	"context"
    21  	"time"
    22  )
    23  
    24  // Timeout returns the remaining time after which work done on behalf of this context should be
    25  // canceled, or ok==false if no deadline/timeout is set.
    26  func timeout(ctx context.Context) (timeout time.Duration, ok bool) {
    27  	if deadline, ok := ctx.Deadline(); ok {
    28  		return deadline.Sub(time.Now()), true
    29  	}
    30  	return 0, false
    31  }