github.com/cloudwego/kitex@v0.9.0/client/streamclient/client_option.go

/*
 * Copyright 2023 CloudWeGo Authors
 *
 * 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
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package streamclient

import (
	"context"
	"time"

	"github.com/cloudwego/kitex/client"
	"github.com/cloudwego/kitex/pkg/discovery"
	"github.com/cloudwego/kitex/pkg/endpoint"
	"github.com/cloudwego/kitex/pkg/http"
	"github.com/cloudwego/kitex/pkg/loadbalance"
	"github.com/cloudwego/kitex/pkg/loadbalance/lbcache"
	"github.com/cloudwego/kitex/pkg/remote"
	"github.com/cloudwego/kitex/pkg/stats"
	"github.com/cloudwego/kitex/pkg/warmup"
	"github.com/cloudwego/kitex/pkg/xds"
)

// These options are directly translated from client.Option(s). If you can't find the option with the
// same name in client.Option(s), most probably it means it's not for streaming clients.

// WithSuite adds an option suite for client.
func WithSuite(suite client.Suite) Option {
	return ConvertOptionFrom(client.WithSuite(suite))
}

// WithMiddleware adds middleware for client to handle request.
// NOTE: for streaming APIs (bidirectional, client, server), req is not valid, resp is *streaming.Result
// If you want to intercept recv/send calls, please use Recv/Send Middleware
func WithMiddleware(mw endpoint.Middleware) Option {
	return ConvertOptionFrom(client.WithMiddleware(mw))
}

// WithMiddlewareBuilder adds middleware that depend on a per-client context for client to handle request
// NOTE: for streaming APIs (bidirectional, client, server), req is not valid, resp is *streaming.Result
// If you want to intercept recv/send calls, please use Recv/Send MiddlewareBuilder
func WithMiddlewareBuilder(mwb endpoint.MiddlewareBuilder) Option {
	return ConvertOptionFrom(client.WithMiddlewareBuilder(mwb))
}

// WithInstanceMW adds middleware for client to handle request after service discovery and loadbalance process.
func WithInstanceMW(mw endpoint.Middleware) Option {
	return ConvertOptionFrom(client.WithInstanceMW(mw))
}

// WithDestService specifies the name of target service.
func WithDestService(svr string) Option {
	return ConvertOptionFrom(client.WithDestService(svr))
}

// WithHostPorts sets the host ports for a stream client.
func WithHostPorts(hostPorts ...string) Option {
	return ConvertOptionFrom(client.WithHostPorts(hostPorts...))
}

// WithResolver provides the Resolver for kitex client.
func WithResolver(r discovery.Resolver) Option {
	return ConvertOptionFrom(client.WithResolver(r))
}

// WithHTTPResolver specifies resolver for url (which specified by WithURL).
func WithHTTPResolver(r http.Resolver) Option {
	return ConvertOptionFrom(client.WithHTTPResolver(r))
}

// WithLoadBalancer sets the loadbalancer for client.
func WithLoadBalancer(lb loadbalance.Loadbalancer, opts ...*lbcache.Options) Option {
	return ConvertOptionFrom(client.WithLoadBalancer(lb, opts...))
}

// WithConnectTimeout specifies the connection timeout.
func WithConnectTimeout(d time.Duration) Option {
	return ConvertOptionFrom(client.WithConnectTimeout(d))
}

// WithTag sets the customize tag for service discovery, eg: idc, cluster.
func WithTag(key, val string) Option {
	return ConvertOptionFrom(client.WithTag(key, val))
}

// WithTracer adds a tracer to client.
func WithTracer(c stats.Tracer) Option {
	return ConvertOptionFrom(client.WithTracer(c))
}

// WithStatsLevel sets the stats level for client.
func WithStatsLevel(level stats.Level) Option {
	return ConvertOptionFrom(client.WithStatsLevel(level))
}

// WithPayloadCodec to set a payloadCodec that handle other payload which not support by kitex
func WithPayloadCodec(c remote.PayloadCodec) Option {
	return ConvertOptionFrom(client.WithPayloadCodec(c))
}

// WithConnReporterEnabled to enable reporting connection pool stats.
func WithConnReporterEnabled() Option {
	return ConvertOptionFrom(client.WithConnReporterEnabled())
}

// WithWarmingUp forces the client to do some warm-ups at the end of the initialization.
func WithWarmingUp(wuo *warmup.ClientOption) Option {
	return ConvertOptionFrom(client.WithWarmingUp(wuo))
}

// WithXDSSuite is used to set the xds suite for the client.
func WithXDSSuite(suite xds.ClientSuite) Option {
	return ConvertOptionFrom(client.WithXDSSuite(suite))
}

// WithContextBackup enables local-session to retrieve context backuped by server,
// in case of user don't correctly pass context into next RPC call.
//   - backupHandler pass a handler to check and handler user-defined key-values according to current context, returning backup==false means no need further operations.
func WithContextBackup(backupHandler func(prev, cur context.Context) (ctx context.Context, backup bool)) Option {
	return ConvertOptionFrom(client.WithContextBackup(backupHandler))
}