github.com/cloudwego/kitex@v0.9.0/client/callopt/streamcall/call_options.go (about)

     1  /*
     2   * Copyright 2023 CloudWeGo Authors
     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 streamcall
    18  
    19  import (
    20  	"time"
    21  
    22  	"github.com/cloudwego/kitex/client/callopt"
    23  )
    24  
    25  // These options are directly translated from callopt.Option(s). If you can't find the option with the
    26  // same name in callopt.Option(s), most probably it means it's not for streaming clients.
    27  
    28  // WithHostPort specifies the target address for an RPC call.
    29  func WithHostPort(hostPort string) Option {
    30  	return ConvertOptionFrom(callopt.WithHostPort(hostPort))
    31  }
    32  
    33  // WithURL specifies the target for a RPC call with url.
    34  // The given url will be resolved to hostport and overwrites the result from Resolver.
    35  func WithURL(url string) Option {
    36  	return ConvertOptionFrom(callopt.WithURL(url))
    37  }
    38  
    39  // WithConnectTimeout specifies the connection timeout for a RPC call.
    40  func WithConnectTimeout(d time.Duration) Option {
    41  	return ConvertOptionFrom(callopt.WithConnectTimeout(d))
    42  }
    43  
    44  // WithTag sets the tags for service discovery for an RPC call.
    45  func WithTag(key, val string) Option {
    46  	return ConvertOptionFrom(callopt.WithTag(key, val))
    47  }